Skip to content

Development documentation for SCG cluster for easy collaboration

Notifications You must be signed in to change notification settings

stanford-rc/docs-scg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

SCG (Development) Documentation

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.

Usage

1. Get the code

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 docs

2. Customize

The markdown files in docs render into the site. We use the default readthedocs mkdocs theme, with an extra css file for styling.

How do I add pages?

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.

3. Serve

You'll need mkdocs installed:

pip install mkdocs

And then you can build locally into a site folder:

mkdocs build

And then cd into the folder, start a local web server to test.

cd site
python -m http.server 9999

About

Development documentation for SCG cluster for easy collaboration

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published