Home

Awesome

WDocs

WDocs is a documentation theme for wmk.

Settings

WDocs has several configuration options which affect the template output or other functionality of the generated website.

Site variables

Default settings for site:

site:
    name: WDocs
    description: Documentation theme for wmk
    author: Baldur Kristinsson
    leading_path: ''
    base_url: ''
    repo_url: 'https://github.com/bk/wdocs-theme/'
    repo_name: WDocs on Github
    avec_theme: default
    tags_in_nav: true
    highlightjs: false
    hljs_style: github
    hljs_languages: []
    fontawesome: false
    auto_title_h1: false
    copyright: |
        Created with the <a href="https://github.com/bk/wdocs-theme">WDocs</a>
        documentation theme for <a href="https://wmk.baldr.net/">wmk</a>.
    tagline: 'Simple and easy documentation'
    extra_css: []
    extra_javascript: []
    navigation_depth: 2
    favicon: 'img/favicon.ico'
    lang: 'en'

Nav setting

nav:
    - Home: /
    - Usage:
        - Getting started: usage/getting-started
        - Advanced settings: usage/advanced
    - About:
        - Impressum: about/impressum
        - License: about/license
        - Help: about/help
    - Resources:
        - Code repository: https://github.com/example/repo/
        - Forum: https://example.discourse.group/

The nav setting has the structure shown in the example. It is presented by the WDocs theme as a navigation tree for the site, i.e. as a hierarchical navigation menu in the header bar (in desktop browers) and in a "hamburger" menu (in mobile and tablet browsers). It also forms the basis of the Next and Previous links that are available on those pages that are in the nav structure.

Other settings

WDocs also supplies theme settings for lunr_index, markdown_extensions, and markdown_extension_configs. Most notably it turns site search on by default. These standard settings described in the wmk documentation.

Further information

Further documentation about the WDocs theme as well as an example site is available here.

Author and license

Author: Baldur Kristinsson.

This theme is made available under the MIT license.

Acknowledgements: The general structure and design of WDocs (but not the code) is based on the default MkDocs theme.