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

[Bug report] Improve visibility / discovery of the "Custom Container" (:::) syntax feature #29

Closed
polarathene opened this issue Jul 5, 2024 · 5 comments
Labels

Comments

@polarathene
Copy link

polarathene commented Jul 5, 2024

Description

Your docs page doesn't seem to mention the syntax for admonition/aside/alert (name varies based on docs generator):

image

I am referring to the Tip section at the bottom there, where inspecting the source reveals the syntax:

### Header Anchors
You might have noticed that, a `#` anchor is displayed when you hover the mouse on the headers of each section. By clicking the `#` anchor, you can jump to the section directly.
::: tip
This header anchors extension is supported by [markdown-it-anchor](https://github.com/valeriangalliat/markdown-it-anchor).
Config reference: [markdown.anchor](../reference/config.md#markdown-anchor)
:::

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).

@Mister-Hope
Copy link
Member

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.

@polarathene
Copy link
Author

Can you open a pr from a user sight of view?

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.

@meteorlxy
Copy link
Member

meteorlxy commented Jul 15, 2024

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)

@github-actions github-actions bot added the stale label Jul 31, 2024
Copy link

This issue is marked as stale because it has not had recent activity. Issues marked with stale will be closed if they have no activity within 7 days.

Copy link

This issue is marked as stale because it has not had recent activity. Issues marked with stale will be closed if they have no activity within 7 days.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants