Skip to content

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

Open
@polarathene

Description

@polarathene

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions