Markdown Documentation with Vitamins

Get Started  ❖  Get Started with Docker  ❖  Demo  ❖  Features  ❖  Contributors

Tip

🚀 Check out the new candidate pre-release on the next branch here.

Warning

DocsHub is still in development. You cannot clone the repository yet. Alternatively, you can try it with Docker.

🧑‍🚀 Introduction

DocsHub is a self-hosted application designed to make documentation effortless. Just focus on writing in Markdown, and let DocsHub handle the rest.

• Live demo: docshub.vercel.app

✨ Features

• Syntax Highlighting with Copy Function: Easily view and copy code snippets directly from the documentation.
• Friendly URLs: Clean and user-friendly URLs for better navigation and sharing.
• Table of Contents: Automatically generated table of contents for quick and easy access to different sections.
• Categorized Menu: Organized menu structure to easily navigate through different categories and sections.
• Search Documentation: Quickly find and navigate to specific entries within the documentation.
• Endpoint Documentation: Ability to document API endpoints for better clarity and usage.
• Alerts: Option to document using an alert component for important messages.

🤝 Contributors