Lumocs: A Documentation Theme for Lume

Lumocs offers a sleek documentation theme for Lume, similar to “just-the-docs” for Jekyll. Explore the full details in the Lumocs Documentation.

Features

• Elegant design tailored for documentation.
• Hierarchical navigation with up to three content levels.
• Mobile-responsive design.
• Easy customization using _data.json and _includes.
• Automatic light/dark mode by user preference, manual Dark mode toggle.
• Enhanced Markdown support via markdown-it.
• Speedy performance optimizations.
• Built with modern tools: Deno and Lume.
• Ready for deployment on GitHub Pages.

Quick Setup

• Familiarize yourself with the required configurations in the provided demo-repository. This includes the _config.ts, _data.json, deno.json, and sample Markdown content like index.md.

Build Command

• Use deno task serve to start a local development server, or deno task lume to compile your site to the _site subfolder.

More Details & Deployment

• Detailed setup is available in the demo-repository.
• Guidelines for GitHub Pages deployment can be found in deploy-pages.yml.
• Full documentation at lumocs.56k.guru.

License

Lumocs is licensed under the MIT License.