Themes

Limedocs comes with a default theme called yuzu but you can easily install, customize or even develop your own themes.

Installing and using a theme

Themes can be installed using npm:

$ cd /path/to/my/docs
$ npm install some-limedocs-theme

Then reference the theme in your limedocs.config.js file:

module.exports = {
  // ...
  themeConfig: {
    theme: "some-limedocs-theme"
  }
  // ...
}

Customize a theme

You can easily customize an existing theme by overriding layouts, partials, tags, shortcodes and static files by putting yours in ${siteDir}/theme, like this:

my-site
  ├── content
  │   ├── some-dir
  │   └── another-one
  └── theme # optional directory where to put overrides
      ├── layouts # your specific layouts (optional)
      ├── partials # your specific partials (optional)
      ├── shortcodes # your specific shortcodes (optional)
      └── static # your specific static files (optional)
Info

All files that you put in theme/static will be copied to your website static directory.

Layouts

A theme consists of one or more layouts, and each page of your site is associated with a layout. For example, you may want to have a home layout for your homepage, an article layout for your articles, and a contact layout for your contact page. If a page is not explicitly associated with a layout, the default layout will be choosed to render your page. Lastly, layouts can use and reuse partials (chunks of layouts).

Developing themes

Themes are written using Nunjucks templating engine (similar to Jinja, Handlebars / mustache). When developing themes for Limedocs, you can add you own shortcodes, filters and tags.

Learn how to develop themes by reading the Theme API.

Edit this page / submit change