-
Notifications
You must be signed in to change notification settings - Fork 131
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
[Bug report] Improve visibility / discovery of the "Custom Container" (:::
) syntax feature
#29
Comments
Can you open a pr from a user sight of view? Only en is ok, if we think this is good, I will sync zh docs. |
No sorry, I'm not a VuePress user. I reported this when I came across it while writing this reply on another project. I link to the equivalent feature in other doc generators, you could reference those. |
It used to be in the core in v1, but it would require all themes to implement styles for custom containers, which is not necessary, so we moved it into theme scope. But yes, as it's a widely used syntax, we may consider integrating it into core again, or move the docs back to core (just like the markdown code extensions) |
This issue is marked as |
This issue is marked as |
@Mister-Hope I noticed you removed stale last time, not sure if you still feel this is stale (the time for stale status applying again appears a bit aggressive btw). Just pinging in case you wanted to keep this open. I came across VuePress docs again and couldn't find anything about this in the v2 pages 😓 |
Description
Your docs page doesn't seem to mention the syntax for admonition/aside/alert (name varies based on docs generator):
I am referring to the Tip section at the bottom there, where inspecting the source reveals the syntax:
docs/docs/guide/markdown.md
Lines 20 to 28 in 3b0eefe
It's a common feature that I assume is available by default with VuePress (never used the project myself), so might be worth documenting. If it is documented somewhere I had trouble identifying where.
EDIT: I found it documented separately for the theme itself as "Custom Container" markdown syntax: https://ecosystem.vuejs.press/themes/default/markdown.html#custom-containers
Since your docs are showing that feature off quite a bit, might be worth referencing that more directly to the audience that is likely to be interested in the feature (searching for
:::
or similar common words for the syntax/type doesn't really help).The text was updated successfully, but these errors were encountered: