Drumkit includes all the necessary components to embed a Hugo documentation site in your main project.
At the root of the project, you can install a complete hugo site using
If you want to use a specific version of hugo, you can speficy it using the variable
docsfolder that contains the skeleton of a hugo site
learntheme for hugo
To see the new hugo site on a local development machine,
cd into the
docs folder and
hugo serve. This will start a local server on port 1313 that will automatically reload as you make changes to the files.
The automatically generated starting point is in
docs/content/_index.md. To publish this page, you need to remove the
draft: true line from the title section.
For guidance on using hugo to layout your docs site, refer to hugo documentation
Initialization of the hugo docs site with drumkit includes the addition of a
gitlab-ci.yml file at the root of the project.
This file is used by gitlab-runner to trigger the CI tests.
If you cloned using the development script, you will need to update the URL of the .mk submodule manually for these tests to run successfully.
Edit the submodule information in
.gitmodules at the root of the containing project. Change the URL of .mk to: https://gitlab.com/consensus.enterprises/drumkit.git
The deployment to Gitlab Pages is managed automatically by the
At the bottom of the file, under
publish stage will run
hugo in the docs folder, which generates a set of static HTML files in the
public folder, which is then made available through Gitlab pages.
The address at Gitlab Pages will be
To set up your Gitlab Pages, you need to update the configuration in
docs/config.yaml, which is set to “http://mygroup.gitlab.io/myproject".