- Production Deployment URL: https://osu-sustainability-office.github.io/
- Test Deployment URL: http://osu-so-wiki.s3-website-us-west-2.amazonaws.com/
Documentation Wiki for Oregon State University Sustainability Office.
The site was built with Docusaurus, so reference their documentation for the basics of how this site functions.
More specifically, this site was built on a template from easyops-cn, so go read the original repository's README if you want more information on the technical details of the site / want to make refactoring changes.
The site is deployed on Github Pages, although it can also be deployed on any static website host.
OSU Sustainability Wiki has the advantage of a search bar feature (frontend only, no database costs). This means that compared to just hosting multiple Markdown files on Github directly, the search UI is much improved on this wiki. Also, combining several projects' worth of documentation into one wiki is more efficient / better UX.
NodeJS
- NodeJS version 18 (
nvm use 18)
Yarn:
npm install --global yarn
How to change Node version:
- See https://github.com/coreybutler/nvm-windows or https://github.com/nvm-sh/nvm
nvm install 18(or whichever version you want)nvm use 18
yarn installto install required node modules.yarn startto open the dev environment to preview the website.yarn buildto build the website locally (needed if you want to test the search function before deployment).- Deployment is handled by the files in
.github/workflows yarn formatfor code formatting
- Review Basic Markdown Syntax.
- Make a Github Account if you don't already have one.
- Make a fork.
- Go to Docs folder (
osu-sustainability-office.github.io/website/docs) and make your edits. Editosu-sustainability-office.github.io/website/sidebars.jsas well if you added a new guide. - Make a Pull request for your changes.
- Useful browser extension if converting Google Docs content to Markdown: https://workspace.google.com/marketplace/app/docs_to_markdown/700168918607