diff --git a/README.md b/README.md index d9ebbe6..b02a942 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,34 @@ 每章翻译开头都带有官方链接和 commit hash,若发现与官方不一致,欢迎 Issue 或 PR :) +## 静态页面构建与文档撰写 + +![image](/vuepress_page.png) + +### 构建 + +你可以将本mdbook构建成一系列静态html页面。这里我们采用[vuepress](https://vuepress.vuejs.org/zh/)打包出静态网页。在这之前,你需要安装[Nodejs](https://nodejs.org/zh-cn/)。 + +全局安装vuepress + +``` bash +npm i -g vuepress +``` + +cd到项目目录,然后开始构建。构建好的静态文档会出现在"./src/.vuepress/dist"中 + +```bash +vuepress build ./src +``` + +### 文档撰写 + +vuepress会启动一个本地服务器,并在浏览器对你保存的文档进行实时热更新。 + +```bash +vuepress dev ./src +``` + ## 社区资源 - Rust语言中文社区:[https://rust.cc/](https://rust.cc/) @@ -19,4 +47,6 @@ 本翻译主要采用 [mdBook](https://github.com/rust-lang-nursery/mdBook) 格式。同时支持 [GitBook](https://github.com/GitbookIO/gitbook),但会缺失部分功能,如一些代码没有语法高亮。 -[GitBook.com](https://www.gitbook.com/) 地址:[https://www.gitbook.com/book/kaisery/trpl-zh-cn/details](https://www.gitbook.com/book/kaisery/trpl-zh-cn/details) \ No newline at end of file +本翻译加速查看站点[上海站点http://rustdoc.saigao.fun](http://rustdoc.saigao.fun) + +[GitBook.com](https://www.gitbook.com/) 地址:[https://www.gitbook.com/book/kaisery/trpl-zh-cn/details](https://www.gitbook.com/book/kaisery/trpl-zh-cn/details) diff --git a/vuepress_page.png b/vuepress_page.png new file mode 100644 index 0000000..367a1b7 Binary files /dev/null and b/vuepress_page.png differ