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

Support parsed argument to directives #39

Open
Mpdreamz opened this issue Nov 6, 2024 · 2 comments
Open

Support parsed argument to directives #39

Mpdreamz opened this issue Nov 6, 2024 · 2 comments
Labels
authoring Relates to our markdown parser question Further information is requested

Comments

@Mpdreamz
Copy link
Member

Mpdreamz commented Nov 6, 2024

Various directives in Myst support providing parsed markdown as directive arguments.

```{directive} Argument
```

However I question whether we want to support this at all.

  • We want uniformly styled documents
  • Typically this is used to bolden text or add colours but this might be a bad practice.

Just for completeness sake, this restriction would not apply to embedded content (Body).

```{directive} Argument
Body
```

@Mpdreamz Mpdreamz added authoring Relates to our markdown parser question Further information is requested labels Nov 6, 2024
@bmorelli25
Copy link
Member

Ah. So disabling, for example, the ability to italicize an admonition title:

Image

Makes sense. I'm looking through the MyST docs and struggling to find an example where this adds value.

@KOTungseth
Copy link

+1

We only want to support emphasis (ie italics, bold, and monospace) in the body of the text. Never in titles at any level.

As a best practice, we should avoid excessive use of any of these styles to prevent cluttering the text. Emphasis should be reserved for when it truly adds value to the reader’s understanding.

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 question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants