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

Provide a way to hide (or at least not look strange) in standard markdown #43

Open
rootwork opened this issue Nov 8, 2021 · 0 comments

Comments

@rootwork
Copy link

rootwork commented Nov 8, 2021

Here's my use case: I have documentation that lives both on a Docusaurus site and in a navigable GitHub repo. The admonitions look great on the Doc site of course, but in GitHub, I just get the standard rendered Markdown, which is:

:::info Foo

Bar

:::

Which isn't that pretty, and if the title is long-ish can actually be hard to visually parse.

  • The easiest solution that I could think of would be to support admonitions inside HTML comments, so that both :::info (etc.) and <!--:::info--> (etc), ::: and <!--:::--> would be valid and result in rendered admonitions. Then in standard Markdown contexts, those lines just wouldn't appear. You'd lose the admonition-type and any custom titles, but that'd be better than nothing.

  • Or, if admonitions were supported (or parsed from) titles, something like this:

## <!--:::info--> Foo

Bar

<!--:::-->

could render like this in standard Markdown contexts:

Foo

Bar

  • But perhaps there would be other ways to accomplish the same thing. Any thoughts?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant