search

jupyter-book / myst-spec

MyST is designed to create publication-quality, computational documents written entirely in Markdown.
https://mystmd.org/spec
MIT License
14 stars 6 forks source link

Standardised identifier for myst documents #15

Open chrisjsewell opened 2 years ago

chrisjsewell commented 2 years ago

It may be useful to have a standard way of signalling that a document is myst, and even perhaps the myst-spec version it is compliant with, particularly if using the (non-specific) .md file extension.

For example, in the top-matter

---
format: myst
format-version: "0.1.0"
---
rowanc1 commented 2 years ago

Love it. Yes.

I have also been thinking that we could potentially suggest some frontmatter structure which could have nice renderers on notebooks, and online. Especially in scientific publishing where you are collecting IDs (orcid, ror, doi, CRediT, etc.).