This is a development repository for the SCG Documentation. The goal is to allow users to contribute, or easily request bug fixes or additions via opening an issue.
You can clone the repository right to where you want to host the docs:
git clone https://github.com/stanford-rc/docs-scg.git docs
cd docsThe markdown files in docs render into the site. We use the default readthedocs mkdocs theme, with an extra css file for styling.
You can add a new page by writing a new markdown file in docs. Navigation can then be found in the mkdocs.yml. The page is automatically built and deployed to GitHub pages using a GitHub workflow.
You'll need mkdocs installed:
pip install mkdocsAnd then you can build locally into a site folder:
mkdocs buildAnd then cd into the folder, start a local web server to test.
cd site
python -m http.server 9999