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

mystRole/mystDirective: use `name` instead of `kind` #31

Closed chrisjsewell closed 2 years ago

chrisjsewell commented 2 years ago

In unified-myst I currently use name, e.g. for {name}`content`, rather than kind

This also syncs with: https://github.com/syntax-tree/mdast-util-directive/blob/4c494b18ac31f27f67b95b917aacc03207d9584f/complex-types.d.ts#L7

Any major objections to changing that here @rowanc1 @fwkoch?

rowanc1 commented 2 years ago

This is for directive names? That sounds fine.

For admonitions, I think we still have a type=admonition, and kind=warning, because those are enums that are well defined?