Spike Bot's Github Pages
Follow the instructions on the Hugo Website. You will need the "Extended" version if an option exists.
git clone --recurse-submodules https://github.com/spike-2/spike-2.github.io.git
All hugo
commands should be run from within the spike-2
folder
- Without drafts:
hugo server --disableFastRender
- With drafts (drafts are not rendered on production):
hugo server --disableFastRender -D
Follow the link in the terminal output. This is a live server, so making changes to the site will rebuild it in real time.
hugo new path/to/title.md
Hugo will try and figure out the content type based on the path. It will generate a markdown file for you to edit.
For your convenience, here are some sample commands:
- Posts:
hugo new posts/title.md
- Documentation:
hugo new docs/manual-pages/plugin-name.md
- Changelog:
hugo new changelog/year/mm-dd.md
- Teach Me:
hugo new teachme/language.md
- Redirect Links:
hugo new links/title.md
- Do not build the site. It's not necessary. Github Actions will build it fresh from the source code.
- Pull Requests must build against the latest Hugo version to be able to be merged.
- The default build directory,
spike-2/public
, is.gitignore
d