Skip to content

shrimp-cloud/shrimp-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

shrimp-doc

创建目录

mkdir shrimp-doc && cd shrimp-doc

使用yarn初始化

yarn init

修改 npm 源,解决依赖拉取问题

npm config set registry https://registry.npmmirror.com

引入 vuepress

yarn add -D vitepress

创建第一个文件

mkdir docs && echo '# Hello VuePress' > docs/README.md

添加启动命令,编译命令

{
  "scripts": {
    "docs:dev": "vitepress dev docs",
    "docs:build": "vitepress build docs"
  }
}

安装依赖

yarn install

本地启动项目

yarn docs:dev

扩展

mermaid 支持

  1. package 追加 mermaidjs
{
    "devDependencies": {
        "vuepress-plugin-mermaidjs": "^1.8.1"
    }
}
  1. config 配置插件
module.exports = {
    plugins: [
        'vuepress-plugin-mermaidjs'
    ],
}

内容区域扩展到100

问题: 内容区域只在整体页面的中间位置,期待让内容靠左。

解决方案:

创建styl文件并放入以下内容:

vim ./docs/palette.styl
.page .theme-default-content:not(.custom) {
    max-width: none;
}