Welcome to your documentation site

This repository powers your docs. Edit files here, push to GitHub, and your site updates automatically.

🌐 Live at: test.minimaldocs.com

Documentation · Support

---

How it works

Edit markdown  →  Push to GitHub  →  Site updates

Your docs are written in MDX (Markdown with components). The docs.json file controls your navigation and site settings.

Quick start

1. Preview locally

npm i -g minimaldocs
minimaldocs dev

Open localhost:3000 to see your docs.

2. Make your first edit

Open index.mdx, change the title, save — watch it update instantly.

3. Push to publish

git add .
git commit -m "Update docs"
git push

Your live site updates within seconds.

Key files

File	Purpose
docs.json	Site name, navigation, colors, logo
index.mdx	Your homepage
logo/	Light and dark mode logos
images/	Screenshots and media

Next steps

📖 Customize your site — colors, logo, navigation

✍️ Write with MDX — formatting, components, code blocks

🔌 Add API docs — auto-generate from OpenAPI specs

---

_{Built with MinimalDocs}