Skip to content

使用 Vitepress 搭建文档网站

支持 TODO 格式

安装依赖

sh
npm install markdown-it-task-lists

修改 config.mts

ts
...
import taskLists from "markdown-it-task-lists";

export default defineConfig({
  markdown: {
    config: (md) => {
      md.use(taskLists);
    },
  },
});

支持 mermaid

安装依赖 vitepress-plugin-mermaid

其它:

部署到 Nginx 虚拟主机

修改 config.mts 调整文档相对路径

ts
export default defineConfig({
  base: "/notebook/",
});

修改 Nginx 配置文件 /etc/nginx/sites-enabled/default

server {
  location /notebook {
    alias /var/www/notebook/;
    index index.html index.htm;
  }
}