Installation: Introduction

Version management #


Third party applications #

ApplicationMinimum version
Hugo (Extended version)

Assets used in the theme #

AssetUsed versionType
Bulmacss
Font Awesomecss
Overlay Scrollbarcss/js
FlexSearchjs
Mermaidjs
QRiousjs
Introjs
Swagger UIjs

Installation #


Hugo website creation #

To create a Hugo website, the Hugo documentation provides a complete Quickstart which includes all the necessary steps to easily and quickly create a Hugo website.

Adding the theme #

  1. To add and use the Shadocs theme with a Hugo website, use one of the following possibilities:

    • Add the theme as a Git submodule to the website project (Recommended method)
      cd ${PROJECT_DIRECTORY}
      git submodule add https://github.com/jgazeau/shadocs.git themes/shadocs
      git submodule update --init --recursive
      
    • Download the theme sources and add them to the website project in the themes/shadocs directory
  2. Add the theme to the website configuration file:

    config.toml
    [...]
    theme = "shadocs"
    [...]