@huyooo/markdown-ui
v0.3.27
Published
Vue 3 文档/ Markdown 展示组件与样式库,支持主题变量与暗色模式。
Readme
@huyooo/markdown-ui
Vue 3 文档/ Markdown 展示组件与样式库,支持主题变量与暗色模式。
仅使用样式
若只需 .markdown-body、代码高亮、容器块(info/tip/warning)等样式,引入 CSS 即可:
import '@huyooo/markdown-ui/dist/style.css'需确保宿主应用已提供主题变量(如 @huyooo/ui 的 theme.css 或自行定义 --huyooo-layout-text、--huyooo-link-color 等),暗色时给 body 加上 class="dark"。
使用组件
import {
CodeBlock,
CodeDemo,
CodeGroup,
CodeGroupItem,
MarkdownViewer,
CatalogueAside,
ImageLightbox,
} from '@huyooo/markdown-ui'- MarkdownViewer:左侧正文 slot + 右侧 TOC,TOC 从渲染后的标题 DOM 提取(单管道,无需传 raw)。
- CodeBlock:支持
code、lang、showLineNumbers,复制按钮带「已复制」反馈。 - ImageLightbox:包裹正文后,点击其中的图片可全屏预览。
主题变量依赖
见 @huyooo/ui 的 theme.css,常用:--huyooo-layout-text、--landing-title-color、--huyooo-link-color、--huyooo-surface-bg、--huyooo-border-color、--huyooo-warning-bg、--huyooo-warning-text 等。
