Contributing Documentation

Contributing documentation is pretty straightforward, follow this basic guide to learn how.

A brief history

This page was built with the Hugo framework & static site generator using the Relearn theme and hosted on GitHub Pages. Every commit to the main branch will trigger a GitHub Action, causing the page to rebuild itself. This takes only a minute or two before the changes are updated. This structure provides a beautiful site, solid uptime, and the ability to even make edits in the GitHub web editor.

Editing existing pages

Navigate to the page that you would like edit and select the icon in the top right of the page. See Learning the syntax for more information on making edits.

Creating new pages & sections

Create a new folder, named whatever you want inside of content/<desired location>. Create a new file here named _index.md, this file will contain your page’s content. If sub-pages are desired, add a new file titled <filename.md> inside of your newest folder. See Relearn Theme Docs for better documentation.

Learning the syntax

The syntax used here can be as simple as Markdown (Discord uses this), however, may get more advanced if you want something fancy.

The following two guides are excellent sources for learning Markdown:

This framework also allows the use of HTML code instead of Markdown, however, Shortcodes may be better suited to what you want to do.

The following two references may help you learn the Shortcodes that may be used:

Making local edits

In order to make local edits on your own machine, we will need to follow a couple of steps:

  1. Install Git if you do not already have it
  2. Install Hugo (Extended edition)
  3. Install Go
  4. Clone https://github.com/YCP-Rev-Metrix/Wiki.git in your favorite IDE or terminal
  5. Open a Git terminal in the directory of your new repository. For VS users, this can be (Toolbar) Git > Open in command prompt
  6. Launch a live server by calling hugo serve (git or wsl terminal)
  7. Navigate a browser to http://localhost:1313/Wiki
  8. Make changes (mostly in content directory). After saving, you should see the page refresh live.
  9. After making your changes, push or merge your changes back up to the main branch. Your changes will now be reflected on the WWW in a few minutes.