Tags vs frontmatter

Notes

  • Only 3 uses identified so far in PR:
    • children
    • short_name
    • open
  • More coming?
    • mdx tags for tests?
    • notebook tags for JS?

Tags

Idea: Use tags like:

@children foo bar baz/

Actually, prefer namespaced tags?

@odoc.children foo bar baz/

Pros

  • No new syntax, ish

Cons

  • Content parsed as odoc content, and we don't have great escaping rules etc
  • Tags are syntactically valid in mli files, where they don't apply

Neutral

  • Requires changing how block tags are parsed, which in turn depends on whether many packages currently use more-than-one-paragraph blocks
    • How many are there like this?
  • Tags would have to appear at start (at least initially!) - ie, before {0 title}
Select a repo