Skip to content

michaelmccallam/trueblocks-docs

Repository files navigation

GitHub repo for TrueBlocks.io.

hugo rsync link checker

Contributing

To develop on this site, you need npm and hugo.

To run locally:

  1. Install npm dependencies
npm install
  1. serve hugo to local host
hugo server

We have a few customizations, but all the hard work for creating this theme was done by the good people at Doks: https://github.com/h-enk/doks/

Important directories:

  • The Homepage is in the layouts/index.html
  • Content templates go in archetypes
  • layouts contains all information about templates
  • config/_default/menus.toml contains the structure for the overall menu and the section menus

How to add menu items

Open up config/_default/menus.toml.

If you want to add a head section, add a config to [[main]].

[[main]]   
  name = "Docs"
  url = "/docs/prologue/introduction/"
  weight = 10

The more "weight", the farther to the left it will be.

Then change some files in layouts. Check out the files the template owner changed here. atwriter/new_doks_site#1

If you want to add a subsection, it will look like this under [[<section-name>]]

[[docs]]
  name = "Tools"
  weight = 20
  identifier = "tools"
  url = "/docs/concepts/"

The more weight it has, the farther down the section will be.

When you create content, you probably want to create corresponding directories in content.

Packages

No packages published

Languages

  • HTML 99.1%
  • Other 0.9%