Skip to content

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

License

Notifications You must be signed in to change notification settings

atmgrupomaggioli/docshub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Markdown Documentation with Vitamins

Start DocsHub with CLI  ❖  Source Code  ❖  Live Demo  ❖  Contributing  ❖  License

Astro Badge TailwindCSS Badge Docker Badge MDX Badge Mermaid Badge GitHub Release GitHub stars GitHub issues

DocsHub

πŸ§‘β€πŸš€ Introduction

Warning

DocsHub is a work in progress. If you find any bug or have any suggestion, please open an issue.

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

✨ Features

  • CLI: Create a new Docshub application or new documents using the command line.
  • Syntax Highlighting: Easily view and copy code snippets directly from the documentation.
  • Automatically categorised menu: Organized menu structure to easily navigate through different categories and sections.
  • Table of Contents: Automatically generated table of contents for quick and easy access to different sections.
  • Search Documentation: Quickly search your documentation for specific entries using Cmd+K.
  • Mermaid Support: Create beautiful diagrams and flowcharts using Mermaid.
  • UI Components: Includes a variety of UI components for better user experience.
  • Lucide icons: Easily add icons to your documentation entries for a better browsing experience.

πŸ“š Documentation

You can check the Docshub documentation here. This documentation also serves as a live demo of the application.

🀝 Contributing

If you find any bugs or have a new idea, please create a new issue or contribute using source code and submit a pull request.

Thank you for helping us improve! 😊

πŸ“ License

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •