跳转到内容

VaultKit 包指南 29 篇

  1. 1. vitepress-theme-vault:把 Obsidian 库发布成博客的一站式主题
    用 Obsidian 写作的人迟早会遇到同一个问题:笔记想发布成博客,但 vault 里的 双链、callouts、 嵌入这些方言语法,任何通用静态站点生成器都不认识;而且 vault 里混着日记、草稿、模板,绝不能整库上网。@vaultkit/vitepress-theme-vault 就是为这条链路而生的 Vite…
  2. 2. markdown-it-obsidian-callouts:Obsidian Callouts 语法完全指南
    Callouts 是 Obsidian 里最常用的排版元素——一个 > 就能把提示、警告、示例从正文里凸显出来。但把笔记发布上网时,通用 Markdown 渲染器只会把它当成普通引用块。@vaultkit/markdown-it-obsidian-callouts 在任何 markdown-it ≥ 14 环境里补齐这…
  3. 3. nuxt-typography:card、callout、steps 排版容器完全指南
    技术博客写多了就会发现,光有正文和代码块不够用:推荐阅读要卡片、重点提示要色块、安装教程要步骤列表、长配置文件要能折叠。Nuxt 官方文档的 Prose 组件把这套排版语言打磨得很成熟,@vaultkit/vitepress-plugin-nuxt-typography 把它带进 VitePress:五种容器(card…
  4. 4. obsidian-canvas:把 Obsidian 白板嵌进文章
    在 Obsidian 里画的白板(.canvas 文件,即开放格式 JSON Canvas),能不能像一张图片一样直接嵌进已发布的文章里?@vaultkit/vitepress-plugin-obsidian-canvas 的答案是:能,而且是构建期一次成型、客户端零运行时的静态嵌入——节点、连线、箭头、标签、颜色全部…
  5. 5. mindmap:标题大纲一键变思维导图
    长文章的结构,目录列表看得见层级、看不见形状。@vaultkit/vitepress-plugin-mindmap 把 VitePress 已渲染文章的标题层级一键变成可交互的思维导图:横向树状铺开、分支按深度着色、圆点折叠展开、点标题跳回正文——本站每篇文章侧栏的「思维导图」页签就是它,现场即可体验。
  6. 6. local-graph:Obsidian 风格关系图谱组件
    双链笔记发布成网站后,最让人怀念的往往是 Obsidian 那张关系图谱。@vaultkit/vitepress-plugin-local-graph 把 Obsidian Publish 风格的 Interactive Graph 带进 VitePress:d3-force 力导向布局 + SVG 自渲染,节点半径随…
  7. 7. content-toc:circuit 走线目录组件
    VitePress 默认的右侧大纲够用但寡淡:一根竖线加一段高亮。Nuxt UI 的 ContentToc 有个漂亮得多的 highlightVariant: circuit 变体——目录左侧是一条随缩进弯折的「电路板走线」,高亮段像电流一样随滚动在走线上流动。@vaultkit/vitepress-plugin-co…
  8. 8. word-cloud:确定性布局的标签词云组件
    词云是标签页与归档页的经典一图流:词频权重一眼可读,还顺手当导航用。但大多数词云组件有个恼人的通病——每次刷新都洗牌,昨天在左上角的标签今天跑到右下角。@vaultkit/vitepress-plugin-word-cloud 用一个种子随机数生成器根治了这个问题:同一份词集,布局永远恒定。本站首页侧栏的「标签」词云就…
  9. 9. contribution-graph:GitHub 风格创作热力图
    GitHub 个人主页那张绿格子贡献图,大概是开发者世界里最有辨识度的信息图。把同款语义搬到博客归档页——每个格子是一天,颜色深浅是当天发文量——写作节奏一眼可见。@vaultkit/vitepress-plugin-contribution-graph 就是这么一个组件:零依赖、纯 CSS Grid、SSR 安全,数…
  10. 10. image-preview:零依赖图片灯箱
    @vaultkit/vitepress-plugin-image-preview 是一个零运行时依赖的 VitePress 全屏图片查看器:点击正文图片即打开灯箱,支持滚轮缩放、1:1 复位、旋转、拖拽平移、同页画廊切换与下载,交互语义对齐 Element Plus Image Viewer。你现在就可以点击本站任意文…
  11. 11. reading-progress:顶部阅读进度条
    @vaultkit/vitepress-plugin-reading-progress 是一个页面顶部阅读进度条 Vue 组件:随滚动从左到右填充,让读者对「还剩多少」有直觉感知。零依赖、零配置即可用——现在就往下滚动本页,注意浏览器窗口最顶端那条与主题品牌色同色的细线,它就是本组件的现场演示。
  12. 12. scroll-navigator:回顶部与到底部浮钮
    @vaultkit/vitepress-plugin-scroll-navigator 是右下角「回顶部 / 到底部」浮钮组 Vue 组件。它解决的是长文导航的两个高频动作:读完想回顶部看目录、想直接跳到文末的评论区。往下滚动本页,右下角出现的那对圆形浮钮就是它的现场演示——本站开箱内置。
  13. 13. reading-time:中英分轨阅读时长统计
    @vaultkit/vitepress-plugin-reading-time 为 VitePress 提供阅读时长统计,架构是「一包两半」:构建期的 markdown-it 插件负责计数并写入 frontmatter,/client 子路径的可选 Vue 组件负责展示。核心卖点是中英分轨计数——中文语料按空格分词会把…
  14. 14. giscus:把评论区建在 GitHub Discussions 上
    @vaultkit/vitepress-plugin-giscus 是 giscus(基于 GitHub Discussions 的评论系统)的轻量 Vue 集成。它不引官方的 @giscus/vue——那层 web component 封装对这里的场景是纯开销——而是直接注入 giscus 官方 client.js,…
  15. 15. copyright:文章版权声明卡
    @vaultkit/vitepress-plugin-copyright 是文章版权声明卡 Vue 组件,挂在正文之后——那是「转载须知」的标准位。卡片三行信息一目了然:文章标题 + 规范链接(带一键复制)、作者(可链到关于页)、许可协议(可链到协议原文),另可选一句转载须知整句。滚到本页末尾就能看到它的现场效果——本…
  16. 16. donate:文章赞赏卡
    @vaultkit/vitepress-plugin-donate 是文章尾部赞赏卡 Vue 组件:支付宝 / 微信收款码页签切换 + PayPal 外链,三渠道按配置门控——配了什么就显示什么,全缺时整卡消失,宿主连 v-if 都不用包。交互是居中的「赞赏」按钮点击展开面板(非模态),SSR 首帧收起态一致、无水合差…
  17. 17. bilibili:B 站视频嵌入完全指南
    @vaultkit/vitepress-plugin-bilibili 为 VitePress / markdown-it 提供 ::: bilibili 容器,一行 Markdown 嵌入哔哩哔哩官方外链播放器(player.bilibili.com)。它基于 markdown-it-container 在构建期直接…
  18. 18. web-frame:浏览器窗口样式的网页嵌入
    @vaultkit/vitepress-plugin-web-frame 为 VitePress / markdown-it 提供 ::: web-frame 容器,把任意网页(或任意 Markdown 内容)装进一个「浏览器窗口」视觉里:三色圆点栏 + 圆角边框 + 柔和阴影,颜色取 VitePress --vp-c…
  19. 19. code-playground:CodePen 与 StackBlitz 嵌入完全指南
    @vaultkit/vitepress-plugin-code-playground 一个包提供两个容器:::: codepen 与 ::: stackblitz,分别对齐 CodePen Embed Builder 与 StackBlitz Embed URL options 官方文档,在 Markdown 里一行嵌…
  20. 20. repo-card:GitHub 与 CNB 仓库卡片完全指南
    @vaultkit/vitepress-plugin-repo-card 提供 ::: repo-card 容器:构建期抓取 GitHub / CNB 仓库元数据(名称、描述、语言、星叉、topics),渲染为静态卡片,零客户端 JS。动画全部 CSS——悬停浮起 + 品牌描边,lg 档另有光泽扫过,prefers-r…
  21. 21. npm-card:npm 包信息卡完全指南
    @vaultkit/vitepress-plugin-npm-card 提供 ::: npm-card 容器:写包介绍、教程文章时一行嵌入 npm 包信息卡——版本、描述、周下载、解包体积、运行时依赖数、license、TS 类型徽标、keywords 一卡集齐。构建期从 npm registry 抓取元数据渲染为静态…
  22. 22. remote-file:远程源码文件嵌入完全指南
    @vaultkit/vitepress-plugin-remote-file 提供 ::: remote-file 容器:构建期抓取 GitHub / CNB 仓库中的文件内容直接嵌入文章,免复制粘贴,随每次部署自动同步。嵌入产物带出处 chrome(平台徽标 + 可点路径链接 + ref / 行号徽标),代码本体走站…
  23. 23. repo-platform-kit:仓库平台统一取数内核
    @vaultkit/repo-platform-kit 是代码托管平台(GitHub / CNB)的统一取数内核:URL 解析、raw 内容与仓库元数据的请求构造、认证策略、带韧性的 TTL 磁盘缓存、平台徽标常量,全部收敛在一个零依赖的 Node 库里。它本身不依赖 VitePress,是 repo-card、rem…
  24. 24. feed:给博客配上 RSS 与 JSON Feed
    @vaultkit/vitepress-plugin-feed 是一个在 VitePress buildEnd 钩子里调用的 RSS + JSON Feed 生成器:一次调用同时产出 feed.xml(RSS 2.0)与 feed.json(JSON Feed 1.1),频道元数据全部从 site 配置与 sitema…
  25. 25. llms:让站点对 AI 友好的 llms.txt
    @vaultkit/vitepress-plugin-llms 是一个在 VitePress buildEnd 钩子里调用的 llms.txt / llms-full.txt 生成器,遵循 llmstxt.org 约定:前者是给 LLM 看的站点索引(标题 + 摘要 + 链接),后者是全文汇编,AI 助手一次抓取就能把…
  26. 26. robots:一分钟配好 robots.txt
    @vaultkit/vitepress-plugin-robots 是一个零配置的 robots.txt 生成器,在 VitePress buildEnd 钩子里调用:hostname 自动取自内置 sitemap 配置,缺省产出「全放行 + Sitemap: 指令」,需要时再用 rules 精细控制各家爬虫——包括屏…
  27. 27. og-image:无浏览器管线的逐页 OG 分享图
    @vaultkit/vitepress-plugin-og-image 在 VitePress buildEnd 钩子里为每个页面生成一张 Open Graph 分享图(1200 × 630 PNG)。管线是 satori(元素树 → SVG,纯计算)+ resvg(SVG → PNG),全程无浏览器——CI 里不需要…
  28. 28. umami:隐私优先的 Umami 统计接入
    @vaultkit/vitepress-plugin-umami 为 VitePress 注入隐私优先的 Umami 统计脚本。它不是运行时组件,而是一个纯构建期函数:把 Umami 配置转换成一条 head 内联脚本条目,塞进 VitePress 的 head 数组即可。
  29. 29. plausible:隐私优先的 Plausible 统计接入
    @vaultkit/vitepress-plugin-plausible 为 VitePress 注入隐私优先的 Plausible 统计脚本。与姊妹包 @vaultkit/vitepress-plugin-umami 同款机制:纯构建期函数,把配置转换成一条 head 内联脚本条目,塞进 head 数组即可。

站点写作指南 2 篇

  1. 1. Callout 语法测试
    本文逐项测试 Obsidian Callouts 的全部语法形态,与 Obsidian 官方帮助页对齐。
    Posts示例
  2. 2. Markdown 语法示例
    本文包含本站支持的全部书写语法:标准 Markdown、VitePress 扩展、Obsidian 专属语法,可作为写作速查(本文自身的 frontmatter 也演示了上方的属性面板)。