https://github.com/hexagon/lumocs

Ready to use dark/light documentation theme for the static site generator Lume
https://github.com/hexagon/lumocs

deno lume markdown static-site-generator

Last synced: 14 days ago
JSON representation

Ready to use dark/light documentation theme for the static site generator Lume

• Host: GitHub
• URL: https://github.com/hexagon/lumocs
• Owner: Hexagon
• License: mit
• Created: 2023-09-28T22:50:35.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-20T21:55:57.000Z (27 days ago)
• Last Synced: 2024-10-30T09:02:31.084Z (17 days ago)
• Topics: deno, lume, markdown, static-site-generator
• Language: CSS
• Homepage: https://lumocs.56k.guru
• Size: 180 KB
• Stars: 15
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lumocs: A Documentation Theme for Lume

Lumocs is a sleek stand-alone documentation theme for Lume, similar to

"just-the-docs" for Jekyll. Explore the full details in the

[Lumocs Documentation](https://lumocs.56k.guru).

## Features

- Design and layout **tailored for documentation**.

- Automatic light/**dark mode** by user preference.

- **No configuration** needed, **works great and looks great** out of the box.

- Generates a documentation website from **markdown**-files, using extended

  `markdown-it` syntax.

- **Easy to customize** using `_data.json` and the `_includes`-folder.

- Mobile-**responsive design**.

- Ready for deployment on **GitHub Pages**.

- **Hierarchical navigation** with up to three content levels.

- Built with **modern tools**: Deno and Lume.

## Quick Setup

Check out the

[Getting Started](https://lumocs.56k.guru/usage/index.html)-section of the

official documentation, or familiarize yourself with the required configurations

in the provided [demo-repository](./demo-repository). This includes the

`_config.ts`, `_data.json`, `deno.json`, and sample Markdown content `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.

## License

Lumocs is licensed under the MIT License.