View the Schema Documentation at docs.overturemaps.org/schema
July 31, 2024 ยท View on GitHub
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:
- Any examples shown on the documentation are pulled from the
examplesfolder. - The interactive schema blocks are built off the YAML files located in the
schemafolder. - The source for the reference pages are the
.mdxfiles located here in thedocs/schemafolder.
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