Skip to content

Latest commit

 

History

History
19 lines (11 loc) · 906 Bytes

README.md

File metadata and controls

19 lines (11 loc) · 906 Bytes

Topgrade Docs

Documentation for Topgrade.

This site currently uses the hugo book theme as a git submodule in themes/book/. An example/documentation site for the theme is at https://themes.gohugo.io//theme/hugo-book/

The example config.toml is at https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.toml

To build:

  • Install hugo and then either:
    • Run hugo --minify to build for release
    • Run hugo serve --minify to run a local server for development

A Github Action is setup at .github/hugo.yaml to host the documentation at Topgrade Docs

TODO:

  • Replace example content in the blog with pertinent information. Or just simply drop the blog since it's unneeded.