_Meta

Documentation contributions are most appreciated. The documentation is built using:

Requirements

  • The Sparta repo
  • Hugo v.0.49.1:

    $ hugo version
    Hugo Static Site Generator v0.49.1 darwin/amd64 BuildDate: 2018-10-10T10:36:40Z
    

Note that the required Hugo version will be automatically installed by the docs branch magefile.go.

Editing

  1. git checkout the docs branch
  2. go get -u -v github.com/magefile/mage
  3. mage InstallHugo
  4. mage -v edit

The last step will startup a server with the documentation made available at http://localhost:1313.

$ mage -v edit
Running target: Edit

Visit http://localhost:1313 for latest documentation
exec: .sparta/hugo server --disableFastRender --watch --enableGitInfo --forceSyncStatic --verbose config.toml
INFO 2018/10/11 06:51:38 Using config file: /Users/mweagle/Documents/gopath111/src/github.com/mweagle/SpartaDOCUMENTATION/config.toml
Building sites … INFO 2018/10/11 06:51:38 syncing static files to /
#...
Serving pages from memory
Web Server is available at //localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop

To make changes to the documentation:

  • Edit the /content subdirectory contents
  • Push your /docs branch to GitHub and open a PR

Visit the Hugo Learn Theme site for complete documentation regarding shortcodes and included libraries.