vuepress-plume-markdown
Supports documentation writing with specialized markdown syntax for containers, code blocks, and media.
Install
mkdir -p .claude/skills/vuepress-plume-markdown && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/3919" && unzip -o skill.zip -d .claude/skills/vuepress-plume-markdown && rm skill.zipInstalls to .claude/skills/vuepress-plume-markdown
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Help users write markdown files with VuePress Plume theme extensions, including containers, charts, embeds, code features, and all markdown enhancements. Invoke when user writes markdown content or asks about Plume's markdown syntax.Key capabilities
- →Configures container-based syntax (tip, warning, info)
- →Handles custom code block tabs and focus highlighting
- →Generates file tree visualization blocks
- →Toggles experimental features via config.ts mapping
- →Parses markdown extensions for advanced layouts
How it works
Maps user intent to specific VuePress Plume syntax tokens defined in the theme guide to structure documentation elements.
Inputs & outputs
When to use vuepress-plume-markdown
- →Add code block features like focus and diffs
- →Insert diagrams or charts into docs
- →Use advanced markdown containers
- →Format technical documentation with tabs
About this skill
VuePress Plume Markdown
Author Markdown for [email protected]. All syntax below matches the current theme — do not
invent variants, and check resources/ before answering syntax questions.
When to Invoke
- Writing/editing any page content: articles, docs, README home page, friend-links page.
- Answering "how do I write X in Plume" (containers, embeds, charts, code blocks, icons, math…).
- Adding page frontmatter (title, tags, cover, sticky, series, home layout…).
Enabling Features
Theme features are gated by theme.markdown (in plumeTheme(), not VuePress's markdown config).
For config work use the vuepress-plume-config skill.
On by default — use directly, no config needed:
hint containers, alert (GitHub alerts), ::: details, ::: tabs, ::: code-tabs, ::: steps,
::: card / ::: card-grid, ::: window, ::: flex, ::: left|center|right|justify, fileTree, plot (!!x!!),
icon (::name::, provider iconify), math (KaTeX), include (<!-- @include: -->), mark (==x==),
emoji (:tada:), attributes ({.cls}), obsidian compatibility (wiki links, embeds, callouts, %%comments%%).
Off by default — enable before documenting:
theme: plumeTheme({
markdown: {
annotation: true, // [+label] + [+label]: note
abbr: true, // *[HTML]: HyperText Markup Language
encrypt: true, // ::: encrypt password="..." (or { password: '123456' })
codeTree: true, // ::: code-tree / @[code-tree](dir)
npmTo: true, // ::: npm-to
field: true, // ::: field-group / ::: field
table: true, // ::: table (enhanced table + highlight)
timeline: true, // ::: timeline
collapse: true, // ::: collapse
chat: true, // ::: chat
demo: true, // ::: demo / @[demo](file)
qrcode: true, // @[qrcode](text) / ::: qrcode
repl: true, // :::rust-repl / go-repl / kotlin-repl / python-repl
pdf: true, bilibili: true, youtube: true, acfun: true,
artPlayer: true, audioReader: true,
codepen: true, codeSandbox: true, jsfiddle: true,
caniuse: true, imageSize: true, obsidian: { ... },
chartjs: true, echarts: true, mermaid: true, markmap: true, plantuml: true, flowchart: true,
},
})
markdown.obsidian is enabled unless explicitly false; its sub-switches are wikiLink, embedLink,
callout, comment (all true). ECharts/Chart.js scripts do not execute unless
markdown.DANGEROUS_ALLOW_SCRIPT_EXECUTION: true (plus an allowlist) is set — see resources/echarts.md.
Syntax Conventions
| Rule | Detail |
|---|---|
| Code fence meta | ```ts title="a.ts" :line-numbers :collapsed-lines=10 {2,4} — title=, :flags and {lines} can be in any order |
| Nested containers | The outer marker needs more colons than the inner one: :::: tabs … ::: hint … ::: … :::: |
| List-based containers | timeline, collapse, steps, chat, field need a blank line between the item title and its body |
| Attributes | Inline: attach directly (**bold**{.red}). List item: on the next line, no blank line. Table: after a blank line |
| Icons | ::mdi:home::, ::mdi:home =24 /#f00:: (two colons each side) |
| Mark | ==text==, requires a space around the delimiters in CJK text |
Feature Index
Layout & containers
| Feature | Resource |
|---|---|
Hint / details containers, alignment (::: left) | resources/container.md |
GitHub alerts (> [!NOTE]) | resources/github-alerts.md |
Tabs & code tabs (::: tabs, ::: code-tabs) | resources/tabs.md |
| Steps | resources/steps.md |
| Timeline | resources/timeline.md |
| Collapse panels | resources/collapse.md |
| Chat dialog | resources/chat.md |
| Field / API docs | resources/field.md |
| Card & card-grid | resources/card.md |
| Window frame | resources/window.md |
| Flexbox row | resources/flex.md |
| Enhanced table + cell merge | resources/table.md |
| File tree / code tree | resources/file-tree.md, resources/code-tree.md |
| Live demo | resources/demo.md |
| Encrypted snippet | resources/encrypt-snippet.md |
| QR code | resources/qrcode.md |
| Browser REPL (rust/go/kotlin/python) | resources/repl.md |
Inline & text
| Feature | Resource |
|---|---|
Highlight ==text== | resources/mark.md |
Icons ::name:: | resources/icons.md |
Hidden text !!text!! | resources/plot.md |
Annotations [+label] | resources/annotation.md |
| Abbreviations | resources/abbreviation.md |
Attributes {.class} | resources/attrs.md |
| Math | resources/math.md |
| Emoji | resources/emoji.md |
Environment presets (markdown.env) | resources/env.md |
| Include files | resources/include.md |
| npm → pnpm/yarn/bun/deno | resources/npm-to.md |
| Obsidian syntax (wiki links, embeds, callouts) | resources/obsidian.md |
<llm-only> / <llm-exclude> | resources/llmstxt.md |
Embeds
resources/acfun.md, resources/bilibili.md, resources/youtube.md, resources/artplayer.md,
resources/audio-reader.md, resources/pdf.md, resources/codepen.md, resources/codesandbox.md,
resources/jsfiddle.md, resources/repl.md
Charts
resources/mermaid.md, resources/echarts.md, resources/chart.md (Chart.js), resources/markmap.md,
resources/plantuml.md, resources/flowchart.md
Code blocks
resources/code-features.md — title, line numbers, highlight, focus, diff, warning/error, word highlight,
whitespace, collapsed lines, @[code] import, twoslash.
Pages & components
| Topic | Resource |
|---|---|
| Article frontmatter (post) | resources/frontmatter.md |
Home page (pageLayout: home) | resources/home-page.md |
| Friend links page | resources/friend-links.md |
| Vue components (Card, Badge, Icon, Swiper, RepoCard, NpmBadge, ImageCard, LinkCard, CardGrid, CardMasonry, HomeBox) | resources/components.md |
Article Skeleton
---
title: Article Title
createTime: 2024/01/01 12:00:00
tags: [vue, vuepress]
cover: /images/cover.png
sticky: 1
series: vue3-in-depth
seriesOrder: 2
---
## Section
Content …
<!-- more -->
title, createTime and permalink are auto-filled by autoFrontmatter; only write permalink when a
stable URL is required.
Pitfalls
@tabmust be the first thing on its line (no indentation); blank lines inside a tab body are fine.::: tableuses named attributes (title="..."), not positional text; the title renders below the table.::: qrcode/::: demo/::: code-treetake key=value attributes, not positional titles.::: fieldrequiresmarkdown.field: true;timeline/collapse/steps/chat/tableeach need their switch.- Inside encrypted snippets (
::: encrypt), only static HTML: no Vue components or template syntax. - Chart scripts are inert by default — say so instead of promising interactivity.
@[replit]is deprecated and Replit shut the service down; prefer CodeSandbox/JSFiddle or:::*-repl.
Documentation
When not to use it
- →Standard markdown writing without theme-specific requirements
- →Generating output for non-VuePress environments
Prerequisites
Limitations
- →Syntax is vendor-locked to VuePress Plume
- →Requires explicit feature enabling in configuration files
- →Does not validate theme compatibility with older VuePress versions
How it compares
It specifically implements theme-native markup rather than standard generic markdown.
Compared to similar skills
vuepress-plume-markdown side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| vuepress-plume-markdown (this skill) | 2 | 5mo | Review | Beginner |
| write-docs | 6 | 6mo | No flags | Beginner |
| docs-changelog | 4 | 7mo | No flags | Beginner |
| docs-writer | 4 | 7mo | No flags | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by pengzhanbo
View all by pengzhanbo →You might also like
write-docs
tldraw
Writing SDK documentation for tldraw. Use when creating new documentation articles, updating existing docs, or when documentation writing guidance is needed. Applies to docs in apps/docs/content/.
docs-changelog
google-gemini
Provides a step-by-step procedure for generating Gemini CLI changelog files based on github release information.
docs-writer
google-gemini
Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.
technical-docs
getsentry
Write and review technical documentation for Sentry SDK docs. Use when creating, editing, or reviewing documentation pages, especially MDX files in docs/platforms/.
repo-website-guide-create
open-circle
Create conceptual documentation and tutorial pages for the Valibot website at website/src/routes/guides/. Use when adding guides about schemas, pipelines, async validation, migration, or other topics. Covers directory structure, MDX templates, frontmatter, and content guidelines.
docs
revokslab
ALWAYS use this when writing docs