README.md

gbfs.mobilitydata.org

Source code for gbfs.mobilitydata.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.

Building the site locally

1. In Terminal, change the directory to one where you wish to build the site.
2. Clone this repository:
   • git clone https://github.com/MobilityData/gbfs.mobilitydata.org
3. Ensure you have an up-to-date version of pip:
   • pip install pip
   • N.B.: on macOS, use pip3 install pip with Python 3.
4. Change the directory to the cloned repository, and have requirements.txt installed:
   • pip install -r requirements.txt
   • N.B.: on macOS, use pip3 install -r requirements.txt with Python 3.
5. 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
6. To run the site locally: mkdocs serve
7. To build the site locally only: mkdocs build --clean
8. 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.