Skip to content

Repository navigation

README.md

Latest commit

 

History

History
44 lines (30 loc) · 1.1 KB

README.md

File metadata and controls

44 lines (30 loc) · 1.1 KB
Raw

quickli-docs

Documentation site for quiCkLI, the minimal Python CLI framework.

Built with Docusaurus and deployed to GitHub Pages.

Development

From the repository root:

pnpm install
pnpm --filter quickli-docs start

Or from this directory:

pnpm install
pnpm start

Build

pnpm build

Deploy

Deployment to GitHub Pages is handled by CI. To deploy manually:

pnpm deploy

Configuration highlights

  • i18n: English as default locale; additional locales can be added to docusaurus.config.ts.
  • Mermaid: Diagram support is enabled via @docusaurus/theme-mermaid.
  • Syntax highlighting: Python, Shell (bash), PowerShell, HCL, Docker (container), and YAML (Kubernetes) are enabled in addition to the Docusaurus defaults.
  • AI discoverability: static/robots.txt allows crawling of the documentation site and static/llms.txt provides a machine-readable project summary with links back to the canonical repository documentation and specifications.