diff --git a/README.md b/README.md index 85c5513..fbe2bbb 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ These open-source projects are using docsify to generate their sites. Pull reque ## Development ### prepare -```shell +```bash npm i && npm run dev open http://localhost:3000 ``` diff --git a/docs/README.md b/docs/README.md index d36bae5..53e4fcd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ ### Create a project First create a project, then create a `docs` folder -```shell +```bash mkdir my-project && cd my-project mkdir docs && cd docs ``` @@ -41,20 +41,20 @@ Push code and activate **GitHub Pages** via your repo's settings Easy to setup and preview a docs. ### Install -```shell +```bash npm i docsify-cli -g ``` ### Setup Setup a boilerplate docs -```shell +```bash docsify init docs ``` ### Preview Preview and serve your docs using -```shell +```bash docsify serve docs ``` diff --git a/docs/index.html b/docs/index.html index 615ba0c..95bddaa 100644 --- a/docs/index.html +++ b/docs/index.html @@ -21,4 +21,6 @@ data-sidebar-toggle data-coverpage data-router> + + diff --git a/docs/zh-cn.md b/docs/zh-cn.md index f714c93..a9dd9b8 100644 --- a/docs/zh-cn.md +++ b/docs/zh-cn.md @@ -8,7 +8,7 @@ ### 创建项目 新建一个空项目，接着创建一个 `docs` 目录并进入到 docs 目录下 -```shell +```bash mkdir my-project && cd my-project mkdir docs && cd docs ``` @@ -46,20 +46,20 @@ mkdir docs && cd docs 方便快速创建文档目录，会读取项目的 `package.json` 里的选项作为 docsify 的配置，支持本地预览。 ### 安装 -```shell +```bash npm i docsify-cli -g ``` ### 初始化文档 默认初始化在当前目录，推荐将文档放在 `docs` 目录下 -```shell +```bash docsify init docs ``` ### 启动本地服务 启动一个 server 方便预览，打开 http://localhost:3000 -```shell +```bash docsify serve docs ```