Lumocs Documentation Theme for Lume

Lumocs provides an elegant documentation theme for Lume, akin to “just-the-docs” for Jekyll. Dive deeper into the Lumocs Documentation.

Setup

  1. Configuration: Set up _config.ts to seamlessly integrate Lumocs with Lume.
  2. Metadata: Define your site’s metadata in _data.json.
  3. Deno Tasks: Configure your Deno tasks within deno.json.
  4. Content: Design your content using Markdown. See the example at index.md.

Commands

  • To build your site, use the command: deno task lume

Examples & Deployment

  • For a comprehensive setup of Lumocs in a /docs directory, check out the demo-repository.
  • To deploy on GitHub Pages, follow the guidelines provided in deploy-pages.yml.

License

Lumocs is available under the MIT License.

This version emphasizes clarity and maintains a consistent tone throughout the README.