Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

aside directive #4

Closed
12 tasks
Tracked by #2
Mpdreamz opened this issue Nov 6, 2024 · 0 comments · Fixed by #58
Closed
12 tasks
Tracked by #2

aside directive #4

Mpdreamz opened this issue Nov 6, 2024 · 0 comments · Fixed by #58
Labels
authoring Relates to our markdown parser

Comments

@Mpdreamz
Copy link
Member

Mpdreamz commented Nov 6, 2024

Aside

Asides provide an easy way to represent content that is only indirectly related to the article’s main content. Where supported, MyST will attempt to display an {aside} as close as possible but separately from the main article, such as in the side-margin.

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

Implementation

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

Specification compliance:

  • Arguments is parsed
  • Body is parsed
  • Options:
    • label, name (string) - *Label the aside to be cross-referenced or explicitly linked
    • class (string)
  • Aliases
    • margin
    • sidebar
This was referenced Nov 6, 2024
@Mpdreamz Mpdreamz added enhancement authoring Relates to our markdown parser and removed enhancement labels Nov 6, 2024
@Mpdreamz Mpdreamz linked a pull request Nov 12, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
authoring Relates to our markdown parser
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant