From ba967b80f3d839a806a61eb9bf48cd9d4620e49f Mon Sep 17 00:00:00 2001 From: guokairui Date: Wed, 25 Oct 2023 18:17:26 +0800 Subject: [PATCH] feat: update readme to use mdbook --- .gitignore | 1 + README.md | 17 ++++++++--------- src/.vuepress/config.js | 9 --------- 3 files changed, 9 insertions(+), 18 deletions(-) delete mode 100644 src/.vuepress/config.js diff --git a/.gitignore b/.gitignore index e83e402..25b8e0a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ mdbook/ book/ dist .DS_Store +.idea \ No newline at end of file diff --git a/README.md b/README.md index 2dc3f3f..9e135bd 100644 --- a/README.md +++ b/README.md @@ -15,30 +15,29 @@ PS: ## 静态页面构建与文档撰写 -![image](./vuepress_page.png) - ### 构建 -你可以将本 mdbook 构建成一系列静态 html 页面。这里我们采用 [vuepress](https://vuepress.vuejs.org/zh/) 打包出静态网页。在这之前,你需要安装 [Nodejs](https://nodejs.org/zh-cn/)。 +你可以将本 mdbook 构建成一系列静态 html 页面。这里我们采用 [mdbook](https://rust-lang.github.io/mdBook/index.html) 打包出静态网页。在这之前,你需要安装 [Rust](https://www.rust-lang.org/zh-CN/)。 -全局安装 vuepress +全局安装 mdbook ``` bash -npm i -g vuepress +cargo install mdbook ``` -cd 到项目目录,然后开始构建。构建好的静态文档会出现在 "./src/.vuepress/dist" 中 +cd 到项目目录,然后开始构建。构建好的静态文档会出现在 "./book/html" 中 ```bash -vuepress build ./src +mdbook build ``` ### 文档撰写 -vuepress 会启动一个本地服务器,并在浏览器对你保存的文档进行实时热更新。 +可以通过任意的 http 服务器来预览构建的文档。举个例子: ```bash -vuepress dev ./src +cargo install simple-http-server +simple-http-server .\book\html\ -i ``` ## 社区资源 diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js deleted file mode 100644 index c459e21..0000000 --- a/src/.vuepress/config.js +++ /dev/null @@ -1,9 +0,0 @@ -// .vuepress/config.js -module.exports = { - themeConfig: { - sidebar: "auto", - nav: [ - { text: '回首页', link: '/' }, - ] - } -};