home	actionText	actionLink
true	快速上手 →	/#命令

使用

::: tip 基于本仓库可快速创建你自己的文档网站。 高亮语法支持列表 PrismJSShiki ::: ::: tip 编译时自动帮你配置菜单栏和侧边栏，最多三层目录结构。 ::: ::: tip 非常多的热心开发者开源主题vuepress-theme :::

::: tip 如果觉得使用VuePressvitepress不便， 可使用静态博客写作客户端gridea :::

目录结构

• 官方标准目录结构

也就是你只需要遵从以上目录结构来修改你自己的文档即可使用。 ::: warning 注意 配置文件中的注释文字部分，请结合VuePress 官方文档一定理解其意义再修改配置！ :::

命令

# 先克隆本仓库
git clone https://github.com/SKT-Shurima/gitbook.git

# 保留上面目录结构列出的文件和文件夹，其他的全部删除

# 使用前请自行安装Node.js环境

# 安装项目的全部依赖
npm install

# 这时创建并书写你自己的md文档

# 开始运行开发环境，然后访问窗口中的路径
npm run dev

# 修改.vuepress/public/CNAME中的域名

# 如果发布到GitHub请见：项目的Actions部署配置
# Actions教程：https://www.bajins.com/IDE/Git%E6%9C%8D%E5%8A%A1.html#actions

::: warning 注意 请确保你的 Node.js 版本 >= 8.6。 :::