gbfs.org

Source code for gbfs.org.

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

Editing site

To edit the General Bikeshare Feed Specification reference, go to the MobilityData/gbfs repository.

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

Alternatively, you can provide feedback using this form.

Contributing translations

GBFS.org uses Simpleen, an automated machine learning translation tool, to ensure translations are kept up to date with repository changes.

Building the site locally

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/gbfs.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 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
7. Assuming you are still in the cloned repository, run this command to update the content for the specification references and best practices:
   • bash scripts/fetchdata.sh
8. 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/
     • French: http://127.0.0.1:8001/
     • Spanish: http://127.0.0.1:8002/
9. To build the site locally only (command defined in MakeFile):
   • make build
10. 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.