Contributing

---

How to contribute

1. Install Hugo
   
2. Clone docs from github
3. Project setup
4. Working with Hugo
5. File structure
6. Learn Markdown
7. Push changes and update the site

---

1. Install Hugo

The latest version of hugo seems to work just fine. Download the file and install it like you would any other application. To check if the installation is successful, open a terminal and type hugo version.

3. Project setup

You won’t need to set up Homestead, Hugo is a static file generator and has its own development server.

4. Working with Hugo

hugo server

hugo server starts a development server similar to npm run watch. Any changes made to the files will automatically reflect in the browser.

1. cd into the docs folder.
2. run hugo server
3. In your browser, type localhost:1313

hugo

This command generates all the static files required and places them in the docs folder, which is the folder containing everything that’s being served on the site.

5. File Structure

Look in the Contents folder, this is where you’ll be working the most. Each main nav item on the sidebar is in its own folder (setup, development, etc).

There’s a index.md file in each folder. That’s where all the content is.

6. Learn Markdown

Read more about markdown’s syntax here.

All of the h2 or ## headings will automatically be listed as submenu items.

All of the headings will automatically be listed in the table of contents section at the top of each section’s page.

7. Updating the site

When you’re ready to push your update to the live site, run hugo, commit then push your changes.