https://github.com/atmgrupomaggioli/docshub

📚 DocsHub is a self-hosted application designed to make documentation effortless. Just focus on writing in Markdown, and let DocsHub handle the rest
https://github.com/atmgrupomaggioli/docshub

astro docker docshub documentation markdown mdx mermaid open-source react self-hosted shadcn-ui typescript

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/atmgrupomaggioli/docshub
• Owner: atmgrupomaggioli
• License: gpl-3.0
• Created: 2024-08-09T10:08:33.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-03-26T09:48:54.000Z (about 2 months ago)
• Last Synced: 2025-04-02T20:55:31.334Z (about 2 months ago)
• Topics: astro, docker, docshub, documentation, markdown, mdx, mermaid, open-source, react, self-hosted, shadcn-ui, typescript
• Language: TypeScript
• Homepage: https://docshub.vercel.app
• Size: 2.81 MB
• Stars: 19
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        










Markdown Documentation with Vitamins




    

        Get Started

    

     ❖ 

    

        Get Started with Docker

    

     ❖ 

    

        Demo

    

     ❖ 

    

        Features

    

     ❖ 

    

        Contributors

    





![Astro Badge](https://img.shields.io/badge/Astro-BC52EE?logo=astro&logoColor=fff&style=flat)

![TailwindCSS Badge](https://img.shields.io/badge/Tailwind_CSS-38B2AC?logo=tailwind-css&logoColor=fff&style=flat)

![Docker Badge](https://img.shields.io/badge/Docker-2496ED?logo=docker&logoColor=fff&style=flat)

![MDX Badge](https://img.shields.io/badge/MDX-1B1F24?logo=mdx&logoColor=fff&style=flat)

![GitHub Release](https://img.shields.io/github/v/release/atmgrupomaggioli/docshub)

![GitHub stars](https://img.shields.io/github/stars/atmgrupomaggioli/docshub)

![GitHub issues](https://img.shields.io/github/issues/atmgrupomaggioli/docshub)



> [!TIP]

> 🚀 Check out the new candidate pre-release on the next branch [here](https://github.com/atmgrupomaggioli/docshub/tree/next).

> [!WARNING]

> DocsHub is still in development. You cannot clone the repository yet. Alternatively, you can try it with [Docker](https://github.com/atmgrupomaggioli/docshub/tree/main/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](https://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