Skip to content

写作与图片 ​

新建文章 ​

在 docs 下按主题创建 Markdown 文件,例如 docs/java/concurrency/thread.md。在 .vitepress/config.mts 的 sidebar 中添加该文章的链接,并在首页加入入口。

建议每篇笔记包含:要解决的问题、核心原理、验证示例、适用边界和参考来源。

插入本地图片 ​

把图片放到文章旁边的 images 文件夹,使用相对路径:

markdown
![架构图说明](./images/architecture.png)

文章和图片需要一起保存、备份。不要引用 C:\\Users\\... 这样的电脑绝对路径,也不要引用剪贴板临时文件。

构建时 VitePress 自动打包被引用的本地图片,并处理网页中的访问路径。本站 JVM 示例 已包含一张实际图片。

公共图片 ​

如果需要全站共用 Logo,可以保存为 docs/public/images/logo.png,然后引用:

markdown
![Logo](/images/logo.png)

路径中不包含 public。这里的路径只是写法示例,需要先放入实际文件。

本地预览 ​

在项目根目录运行:

bash
pnpm docs:dev

打开 http://127.0.0.1:5173,保存 Markdown 后页面会自动更新。

构建与预览发布版本 ​

bash
pnpm docs:build
pnpm docs:preview

发布版本在 http://127.0.0.1:4173 预览,生成文件位于 docs/.vitepress/dist。本项目目前仅本地运行。

参考 ​