GOFS.org

Source code for gofs.org.

This site was built using MkDocs, a static site generator, and Material for MkDocs, a technical documentation theme for MkDocs.

Building or Serving the site locally

Warning

A private token from MKDocs Material Insiders is required to build this site.

1. In Terminal, change the directory to one where you wish to build the site.
2. Ensure you have an up-to-date version of pip:
   • Linux: pip install pip or pip install --upgrade pip
   • macOS: pip3 install pip or pip3 install --upgrade pip
3. Clone this repository:
   • git clone https://github.com/MobilityData/gofs.org
4. Change the directory to the cloned repository, and create & enable a Python virtual environment:
   • python3 -m venv venv
   • source venv/bin/activate
5. Have requirements.txt installed:
   • Linux: pip install --force-reinstall -r requirements.txt
   • macOS: pip3 install --force-reinstall -r requirements.txt
6. Have Material for MkDocs Insiders installed. Substitute ${GH_TOKEN} with a valid access token:
   • Linux: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
   • macOS: pip3 install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
7. To run the site locally (command defined in MakeFile):
   • make serve
   • Then each language will have it's own address:
     • English: http://127.0.0.1:8000/
8. To build the site locally only (command defined in MakeFile):
   • make build
9. Deactivate the Python virtual environment when done:
   • deactivate

License

Except as otherwise noted, the content of this site is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License.