L

Quick Start

1. Install

pip install litedocs

2. Create Docs Folder

my-docs/
├── config.json
└── en/
    ├── _nav.md
    ├── _sidebar.md
    └── index.md

config.json:

{
  "site": { "title": "My Docs" },
  "locales": { "default": "en", "available": ["en"] }
}

en/_nav.md:

- [Guide](guide/index.md)

en/_sidebar.md:

- [Home](index.md)

en/index.md:

---
title: Home
---

# Welcome

Your documentation starts here.

3. Start Server

litedocs serve ./my-docs

Open http://localhost:8000 in your browser.

Tip

Add --port 3000 to use a different port. Use --no-reload to disable file watching.