MobilityData / gbfs.org

Source code for gbfs.org
https://gbfs.org
1 stars 4 forks source link

Use external markdown for the spec reference #66

Closed richfab closed 11 months ago

richfab commented 11 months ago

Problem

Every time we make a change to the spec in the gbfs.md file, we also need to update the reference on gbfs.org to reflect the change. This is a manual task that takes time and that is prone to human error.

Solution

This PR proposes to use the plugin mkdocs-embed-external-markdown to replace the static page by a dynamic import of the content from gbfs.md from the gbfs repository.

With this solution, every time a change is made in the gbfs.md file, it is automatically reflected on gbfs.org (no action needed).

Before After
Screenshot 2023-11-15 at 14 29 10 Screenshot 2023-11-15 at 14 31 13
fredericsimard commented 11 months ago

LGTM !