A simple one page Hugo theme for documentation. Inspired by Hyde, Simpledoc and docDock themes
- all content is rendered on one page
- 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 the main page. Front-matter's anchor
is used for the navigation. Content is ordered by Weight.
When creating a new section, make sure _index.md
exists for correct cross-references.
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
Returns anchor
parameter (see archetypes/default.md
file) of the article
Check [Proxy environment]({{< anchor "installation/proxy-environment.md" >}}) section
Since the theme is a one-page theme, this is the way to make cross-references on the website
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.