1 min read

Introduction

Welcome to our documentation system! This is a lightweight,Docusaurus-like static site generator that's perfect for hosting documentation on GitHub Pages or GitLab Pages.

Features#

  • Markdown-based:Write your documentation in simple Markdown files
  • Static Site Generation:Build fast,static HTML pages
  • Responsive Design:Works beautifully on all devices
  • Easy Navigation:Automatic sidebar and navigation generation
  • Search:Client-side search functionality
  • Git-friendly:Store everything in version control

Quick Start#

  1. Install dependencies:

    Bash
    npm install
  2. Add your documentation in the docs/ folder

  3. Configure your site in config.json

  4. Build and preview:

    Bash
    npm run dev

Next Steps#

Check out the Installation guide to get started!