A simple Hugo theme for documentation. Based on the Kraiklyn one page theme
- unlimited menu level
- mobile friendly
- customize website logo
- add links to the sidebar
Clone the repository to your site’s themes directory.
All content is rendered on it's own page. Content is ordered by Weight.
Create notes, tips and other blocks on the page
{{% block note %}}
By default only ports 22, 80 and 443 are open
{{% /block %}}
Available types: note
, tip
, warn
, info
Replace logo by creating layouts/partials/logo.html
file
Customize the name of the section by adding to the config.toml
[params]
externalTitle = "Surfly docs"
Add new entries:
[[menu.shortcuts]]
name = "Javascript API"
url = "https://docs.surfly.com/javascript.html"
weight = 20
Customize the color of the sidebar by adding to the config.toml
[params]
sidebarColor = "green"
Available values : default, green, purple, pink, red, cyan, blue, grey, orange.
Put favicon.ico
inside static
folder
You can add your custom CSS files with the customCss
parameter of the configuration file.
customCss = ["css/custom.css", "css/custom2.css"]
Just put your files in static/css
directory.