A simple theme for technical documentation purposes.
- LaTeX with MathJax
- Mermaid - generation of diagrams and flowcharts
- Breadcrumbs
- Table of Contents for articles
If you want to test this theme just clone this repository with
git clone git@github.com:akutschi/dokugo.git
and then
cd exampleSite
hugo server --themesDir ../../
Browse site on http://localhost:1313. Or just visit https://akutschi.github.io/dokugo.
Hugo minimum version: 0.69
Create a folder that holds your project and there a folder called content. Assuming that git is installed just initialize Git and simply clone this repository as submodule into your themes folder:
mkdir -p <SITENAME>/content
cd <SITENAME>
git init
git submodule add git@github.com:akutschi/dokugo.git themes/dokugoNow we have created a new Hugo site, initialized a git repository and added the theme as submodule to our site.
Now we add the configuration file and the content from the example site to get started.
cp -r themes/dokugo/exampleSite/content/* ./content/
cp themes/dokugo/exampleSite/config.toml ./Start the built-in Hugo web server with hugo server to check the page:
$ hugo server
Start building sites …
| EN
-------------------+-----
Pages | 76
Paginator pages | 0
Non-page files | 1
Static files | 9
Processed images | 0
Aliases | 0
Sitemaps | 1
Cleaned | 0
Built in 62 ms
Watching for changes in /home/hugo/<SITENAME>/{content,themes}
Watching for config changes in /home/hugo/<SITENAME>/config.toml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/dokugo/ (bind address 127.0.0.1)
Press Ctrl+C to stopOpen http://localhost:1313/ in your web browser and then you can see your website.
The documentation can be found on the demo site or here when you are running the exampleSite with the command above.
Problems? Feature requests? Improvements?
Although this theme is currently optimized for my personal use, feel free to open tickets for issues or merge requests. I am happy to discuss and consider every request. Thank you.
DoKugo is licensed under the GPLv3 license.
Copyright (c) 2021 akutschi