readme.md

R3 Docs Site Usage

These pages are not rendered by Hugo. Hugo only renders pages in the /content folder.

These pages explain how to add more documentation, and some of the site design.

Hugo has extensive documentation.

The docs site runs with continuous deployment. When your pull request is merged the changes will be deployed to 'production' once an automatic hugo build is complete.

Quick Start

Download:

• Visual Studio Code or an editor of your choice.
• Hugo
  • Ensure the hugo binary is on your PATH
• Fork this repository (you can clone it, but you won't be able to push).

Then:

cd docs-site
hugo serve

• Open http://localhost:1313 (or whatever it says in the console)
• Finally, edit Markdown and watch the page update!

I am...

...Authoring Content

• Creating and Editing pages
• Testing your changes
• Pushing your changes

...Authoring New Versions and Modifying the Site

• New documentation versions
• How do the side menus work?
• How does internationlization work?
• How do I update the theme?

...Modifying the Theme

• Start with the Hugo documentation.
• Clone the Hugo R3 theme
• Site design
• Searching

...Changing the Build Pipeline

• Makefiles, docker, and nginx