diboot/diboot-docs
godchao a99850c8bf 1. 新建基于vuepress的文档模块;2. 新建diboot-shiro认证授权模块;3. 基于shiro实现到每个接口级别的RBAC授权;4. 实现便于扩展认证方式(比如微信公众号、企业微信等)的认证架构设计,并且便于多种认证方式同时使用。 2019-06-06 19:41:00 +08:00
..
diboot-core-docs 1. 新建基于vuepress的文档模块;2. 新建diboot-shiro认证授权模块;3. 基于shiro实现到每个接口级别的RBAC授权;4. 实现便于扩展认证方式(比如微信公众号、企业微信等)的认证架构设计,并且便于多种认证方式同时使用。 2019-06-06 19:41:00 +08:00
README.md 1. 新建基于vuepress的文档模块;2. 新建diboot-shiro认证授权模块;3. 基于shiro实现到每个接口级别的RBAC授权;4. 实现便于扩展认证方式(比如微信公众号、企业微信等)的认证架构设计,并且便于多种认证方式同时使用。 2019-06-06 19:41:00 +08:00

README.md

我们使用了什么?

  • 这里的所有文档都使用vuepress这个工具来处理关于vuepress的细节可以阅览官方文档
  • 我们采用markdown来编写项目文档如果您也要参与文档的贡献也需要先了解markdown相关内容。

我们应该怎样开始?

  1. 假设您本地已经安装了node环境npm与yarn至少有其一了那么打开命令行我们先运行以下命令全局安装已经安装过的不必再安装vuepress:
    yarn global add vuepress 
    # 或者:
    npm install -g vuepress
    
  2. 拉取该项目到本地,在命令行打开该目录下的相关文档目录。
  3. 运行以下命令开始启动一个文档的server
    yarn serve
    # 或者:
    npm run serve
    

我们怎样存放静态文件?

  • 我们的图片文件以及其他类型的文件,建议存放在相应文档项目下的.vuepress/public/目录下。

我们如何引入存放的静态文件?

  • 我们统一使用$withBase()方法来获取存放在.vuepress/public目录下的静态文件示例如下
    ![图片]($withBase('/image.png'))