Skip to content

SEO metadata front matter

Barrie Byron edited this page Jun 15, 2023 · 1 revision

Front matter in each doc

Well-written docs help our users discover, understand, and use the Mina Protocol and SnarkyJS. Adding metadata improves the findability and discoverability for Mina docs.

The front matter for each doc topic provides additional metadata for your doc page.

Provide the front matter at the top of every file. For example, https://github.com/o1-labs/docs2/blob/main/docs/zkapps/how-to-deploy-a-zkapp.mdx includes a description and keywords.

Global metadata for all docs

Keywords in https://github.com/o1-labs/docs2/blob/main/docusaurus.config.js are global metadata that is applied to every page. See https://github.com/o1-labs/docs2/blob/main/docusaurus.config.js#L265

Clone this wiki locally