/docs folder contains the Infection Monkey Documentation site.
By order of importance:
The most important directory is
/content. This is the directory which contains the content files. Read this to understand how pages are organized in that folder.
In this directory you should place images,
js files and other static content the site should serve. To access that static content in a page, use something similar to this:
![AWS instance ID](../../images/setup/aws/aws-instance-id.png "AWS instance ID")
This folder controls many of the parameters regarding the site generation.
This is the theme we’re using. It’s a submodule (to get it you need to run
git submodule update). It’s our own fork of the learn theme. If you want to make changes to the theme itself, or pull updates from the upstream, you’ll do it here.
These are the build output of
hugo and should never be
commit-ed to git.
You’ll have to install
hugo, a text editor that’s good for markdown (
vim are good options) and
hugo new folder/page.md. Optionally add
--kind chapter if creating a new chapter page. For example,
hugo new usage/getting-started.md created the Getting Started page.
Edit the markdown file(s). Here’s a markdown cheatsheet. If you want to add images, add them to the
static/images folder and refer to them by name.
hugo server -D. The server will be available locally at
http://localhost:1313/. You can change the content/theme and the site will refresh automatically to reflect your changes.
hugo --environment staging or
hugo --environment production. This will create a static site in the
public directory. This directory should be ignored by
git - make sure you don’t add and commit it by mistake!
Error: Unable to locate config file or config directory. Perhaps you need to create a new site.
Did you confirm your working directory? It should be
failed to extract shortcode: template for shortcode "children" not foundor theme doesn’t seem right?
Have you run
git submodule update?