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.

How can I contribute to gtfs.org?

Submit an issue or a content addition idea

The more ideas, the merrier! If you have an idea for how to improve GTFS.org's content or user experience design, open an issue on the GTFS.org repository.

Suggest a change with a Pull Request

To propose edits to the content, navigate to the page you want to change on GTFS.org and click on the "Edit this page" icon on the top-right of the page. The "Edit this page" icon will direct you to an editable page on the appropriate Github repository. You can then submit your edits as a pull request. 📝

Contributing translations

GTFS.org uses Simpleen, an automated machine learning translation tool, to ensure translations are kept up to date with repository changes. Since our priority is to keep translations up-to-date, any one-time translation contributions will be overwritten by Simpleen in the future.

We do accept glossary changes. Simpleen uses a glossary for key terms that are commonly used across GTFS.org, like trip or station. If you want to suggest a translation for a key term that should be applied across the entire site, you can create an issue on the GTFS.org repository.

Building 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/gtfs.org
4. Change the directory to the cloned repository, and have requirements.txt installed:
   • Linux: pip install --force-reinstall -r requirements.txt
   • macOS: pip3 install --force-reinstall -r requirements.txt
5. Have Material for MkDocs Insiders installed. Substitute ${GH_TOKEN} with MobilityData's 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
6. To run the site locally: make serve
7. To build the site locally: make build

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.