北冥坞文档

中文

English

中文

English

Appearance

系统文档开发 ​

目录结构 ​

/
  • .eslintignore
  • .eslintrc.cjs
  • .prettierignore
  • .prettierrc
  • README.md
  • content
    • .vitepress
      • components
        • LocalSearchBox.vue
        • NavBar.vue
        • NavBarMenuLink.vue
        • NavBarTranslations.vue
      • composables
        • index.ts
      • config.ts
      • configs
        • index.ts
        • locales
          • en.ts
          • index.ts
          • zh-CN.ts
        • search
          • index.ts
          • stopwords.ts
          • translate.ts
      • mathjax.ts
      • shim.d.ts
    • api-examples.md
    • developer-guide
      • dev-docs.md
    • index.md
    • markdown-examples.md
    • public
      • image.jpg
      • logo.svg
    • tsconfig.json
    • zh-CN
      • api-examples.md
      • developer-guide
        • deploy
          • k8s-deploy.md
          • local-deploy.md
        • dev-backend.md
        • dev-docs.md
        • dev-frontend.md
        • structure-and-guidelines.md
      • index.md
      • markdown-examples.md
      • overview
        • installation.md
        • quick-start.md
        • system-overview.md
      • user-guide
        • learnware-deploy.md
        • learnware-search.md
        • learnware-upload
          • prepare.md
          • upload.md
  • package.json
  • pnpm-lock.yaml

环境搭建 ​

  1. 安装 nvm
bash
# use curl:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
# or use wget:
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
# use curl:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
# or use wget:
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
  1. 安装 node
bash
nvm install node
nvm install node
  1. 安装 pnpm
bash
npm install -g pnpm
npm install -g pnpm
  1. 安装依赖: 确保你在项目的根目录 Beiming-System/docs/ 下。
bash
pnpm install
pnpm install

开发 ​

运行开发服务器 ​

运行以下命令来启动开发服务器。

bash
pnpm dev
pnpm dev

如果一切顺利，你应该看到以下输出：

bash
> vitepress dev docs

  vitepress v1.0.0-rc.21

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help
> vitepress dev docs

  vitepress v1.0.0-rc.21

  ➜  Local:   http://localhost:5173/
  ➜  Network: use --host to expose
  ➜  press h to show help

之后，更改 content 目录下的 markdown 文件，浏览器将自动重新加载以显示更改。

添加静态文件 ​

如果你想添加静态文件，比如图片，你可以把它们放在 Beiming-System/docs/content/public/ 目录下。然后你可以在 markdown 文件中这样访问它们：

markdown
![image](/image.png)
![image](/image.png)

设置导航栏和侧边栏 ​

你应该按语言设置。例如，如果你想为 en 语言设置导航栏和侧边栏，你应该编辑 Beiming-System/docs/content/.vitepress/config/locales/en.ts 文件。

其他配置 ​

你可以在 VitePress 文档 中找到更多配置。

部署 ​

运行以下命令来构建静态文件。

bash
pnpm build
pnpm build

静态文件将生成在 Beiming-System/docs/content/.vitepress/dist/ 目录下。你可以将它们部署到任何静态文件服务器。