Giter VIP home page Giter VIP logo

lumocs's Introduction

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.

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-section of the official documentation, or familiarize yourself with the required configurations in the provided 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.

lumocs's People

Contributors

hexagon avatar jarrodu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

lumocs's Issues

Support switch between versions

I'm thinking of using Lumocs to document the API of my app. The API will use SemVer and users should be able to select the version. Is there a plan to implement some kind of dropdown select for this? Like one that is similar to Gitlab's docs:

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.