embed directive

[Mpdreamz]

Embed

Kind	Link
Reference	https://mystmd.org/guide/directives#directive-embed
Documentation	https://mystmd.org/guide/embed

The embed directive allows you to duplicate content from another part of your project. This can also be done through the figure directive.

Implementation

• [ ] Parses directives and aliases
• [ ] Emits HTML
• [ ] Unit tests
• [ ] Validation (emits, warnings and errors).

Specification compliance:

• [ ] Arguments is not parsed and reference a known label
• [ ] Body is not parsed and treated as raw string
• [ ] Options:
  • [ ] remove-input (boolean) - If embedding a Jupyter Notebook cell, remove the input of the cell.
  • [ ] remove-output (boolean) - If embedding a Jupyter Notebook cell, remove the output of the cell.

[Mpdreamz]

As per https://mystmd.org/guide/embed and in particular the section on {include} vs{embed}` I am personally leaning on not implementing this directive and emit a warning for its usage.

• I think it's more prescriptive for reusable content to always live separately and not yank pieces of content from other pages.

What do you think @bmorelli25 ?

(As an aside should we create a GitHub team for folks interested in these types of discussions?)

[bmorelli25]

cc @KOTungseth. We should discuss this one on Monday. We should also ensure the right writers are involved in these conversations.