使用 语雀
、notion
等文档知识库,在使用起来比较方便,但是如果需要本地备份,就需要借助一些工具。本文介绍使用 本地预览框架 vitepress
和 同步网盘 oneDrive
来实现本地知识库 预览+备份。
创建并进入目录,初始化 vitepress 项目。
mkdir local_wiki && cd local_wiki
创建 package.josn
文件,并粘贴以下内容。
{ "name": "local_wiki", "private": true, "scripts": { "docs:dev": "vitepress dev --host --port 10050" }, "devDependencies": { "vitepress": "1.0.0-rc.29" } }
安装依赖,生成 pnpm-lock.yaml
文件。
pnpm install
创建 Dockerfile
文件,并粘贴以下内容。
# 基础镜像 FROM node:16.15.0-alpine # 创建 工作目录 WORKDIR /app # copy 项目到镜像里 COPY . . # 运行命令 RUN npm install -g pnpm && \ pnpm install --frozen-lockfile # 暴露端口 EXPOSE 5173 # 运行 CMD [ "npm", "run", "docs:dev" ]
创建 .dockerignore
文件,并粘贴以下内容。
/.vitepress /.git /caches /node_modules /docs
终端运行以下命令。
docker build -t local_wiki:local -f ./Dockerfile .
如果电脑有 iCloud
、oneDrive
等同步网盘,可以把 projectHostDocsDir
和 projectHostConfigDir
替换成同步目录。如果不需要备份,那就把 2 个配置改成自定义路径即可。
例如:
projectHostDocsDir
=> /Users/pocky/iCloud 云盘(归档)/local_wiki/docs
projectHostConfigDir
=> /Users/pocky/iCloud 云盘(归档)/local_wiki/config
先去创建 projectHostConfigDir
这个预设目录,然后再到 local_wiki/config
目录里创建 config.mts
文件,并粘贴以下内容。
import { defineConfig } from "vitepress"; // https://vitepress.dev/reference/site-config export default defineConfig({ title: "本地文档", description: "本地文档知识库", srcDir: "./docs", cacheDir: "./caches", themeConfig: { search: { provider: "local", }, }, });
同上,也创建 projectHostDocsDir
这个预设目录,然后再到 local_wiki/docs
目录里创建一个 index.md
文件。
# 这是一个 md 文件
把以下的 projectHostDocsDir
和 projectHostConfigDir
变量改成自己的预设路径后,去终端运行此命令。
#!/bin/sh # 镜像信息 dockerImageName=local_wiki dockerImageVersion=local # 运行后的容器信息 dockerContaimerName=L_local_wiki # 端口 dockerHostPort=10050 dockerContainerPort=10050 # 文档目录映射配置 projectHostDocsDir=/XXXXXXXXXXXXXXX/local_wiki/docs projectContainerDocsDir=/app/docs # 配置目录映射配置 projectHostConfigDir=/XXXXXXXXXXXXXXX/local_wiki/config projectContainerConfigDir=/app/.vitepress # ==================== # 运行脚本 runShell(){ # 停止并删除容器 docker container stop $dockerContaimerName; \ docker container rm $dockerContaimerName; \ # 生成容器 docker run -itd \ --name=$dockerContaimerName \ -p $dockerHostPort:$dockerContainerPort \ -v $projectHostDocsDir:$projectContainerDocsDir \ -v $projectHostConfigDir:$projectContainerConfigDir \ $dockerImageName:$dockerImageVersion } runShell
目录配置请看 2.4.运行镜像
终端运行以下命令。
#!/bin/sh # 镜像信息 dockerImageName=pocky2460392754/vitepress_local_wiki dockerImageVersion=1.0.0 # 运行后的容器信息 dockerContaimerName=vitepress_local_wiki # 端口 dockerHostPort=10050 dockerContainerPort=10050 # 文档目录映射配置 projectHostDocsDir=/XXXXXXXXXXXXXXX/local_wiki/docs projectContainerDocsDir=/app/docs # 配置目录映射配置 projectHostConfigDir=/XXXXXXXXXXXXXXX/local_wiki/config projectContainerConfigDir=/app/.vitepress # ==================== # 运行脚本 runShell(){ # 停止并删除容器 docker container stop $dockerContaimerName; \ docker container rm $dockerContaimerName; \ # 生成容器 docker run -itd \ --name=$dockerContaimerName \ -p $dockerHostPort:$dockerContainerPort \ -v $projectHostDocsDir:$projectContainerDocsDir \ -v $projectHostConfigDir:$projectContainerConfigDir \ $dockerImageName:$dockerImageVersion } runShell
浏览器输入 http://localhost:10050
地址,修改 index.md
文件查看效果。
从 语雀
迁移到 notion
, 再从 notion
迁移到 本地
, 或许 本地+网盘同步
才是最好的选择。
https://www.965.ink/archives/1701055919322