Website
This website is built using Hugo and uses the Doks hugo theme.
This git repo is based off the example Doks git repo.
Requirements
Use npm to install dependencies and run commands. Installing npm is pretty simple. Download and install Node.js (it includes npm) for your platform.
Get started
1. Clone the repo
git clone https://github.com/jian-he/website.git
2. Install dependencies
npm install
3. Start development server
npm run start
4. Make your content changes
The result will be refreshed in real-time at http://localhost:1313
5. Add a file
For example:
hugo new docs/recipes/hostnetwork.md
Other commands
Doks comes with commands for common tasks.
Documentation
Communities
FAQ
index.md
vs _index.md
Throughout the repo, you will see index.md
and _index.md
files.
_index.md
is added in the branch
folder, e.g. the prologue/_index.md
lists the files under that prologue
menu.
index.md
is added in the leaf
foler, e.g. workloads/mars/index.md
.
See the doc for details