schema/docs/README.md at main · OvertureMaps/schema · GitHub
Skip to content

Latest commit

 

History

History
16 lines (10 loc) · 1.03 KB

README.md

File metadata and controls

16 lines (10 loc) · 1.03 KB

View the Schema Documentation at docs.overturemaps.org/schema

Editing the Overture Schema Documentation

docs.overturemaps.org is a docusaurus website that builds from the github.com/overturemaps/docs repo

Everything at docs.overturemaps.org/schema comes from here, specifically:

  1. Any examples shown on the documentation are pulled from the examples folder.
  2. The interactive schema blocks are built off the YAML files located in the schema folder.
  3. The source for the reference pages are the .mdx files located here in the docs/schema folder.

Development

Clone this repo, checkout a feature branch, and run the build_docs.sh script. This will check out the OvertureMaps/docs repo and create symlinks for examples, schema, and docs/schema into the build.

You can then edit the .mdx files here in docs/schema (do not worry about the docusaurus folder) and see your changes live at http://localhost:3000