Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.74 KB

README.md

File metadata and controls

27 lines (16 loc) · 1.74 KB

GTFS.org

Source code for gtfs.org.

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

Editing site

To propose a feature, content addition, or UI/UX improvement, open an issue or pull request on this repository.

To edit site content, click on the pencil icon on the top right corner of the webpage to find the source-of-truth document. 📝

Building the site locally

  1. Clone this repository: git clone https://github.com/MobilityData/gtfs.org
  2. Ensure you have an up-to-date version of pip: pip install pip
  3. Have requirements.txt installed: pip install ~/mobilitydata/gtfs.org/requirements.txt
  4. Have Material for MkDocs Insiders installed. Substitute ${GH_TOKEN} with MobilityData's personal access token: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
  5. In the terminal, navigate to the repository directory (~/mobilitydata/gtfs.org) and run this command to update the content for the specification references and best practices: bash scripts/fetchdata.sh
  6. To run the site locally: mkdocs serve
  7. To deploy the site to GitHub Pages: mkdocs gh-deploy

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.