You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bajins c04ff6a785 添加yum源 3 days ago
.vuepress 重命名,和不输出冗余 6 days ago
API 重新调整目录结构 2 weeks ago
Golang 重命名 6 days ago
IDE 重命名不规范图片避免使用时无法获取 2 weeks ago
JAVA 重新调整目录结构 2 weeks ago
JavaScript npm更新依赖 4 days ago
MySQL 重新调整目录结构 2 weeks ago
Nginx Nginx URL重写(rewrite) 2 weeks ago
Other 添加查询 4 days ago
Python 调整结构,使用工具把静态文件写入files.md列出 2 weeks ago
VPS 添加yum源 3 days ago
WEB 重新调整目录结构 2 weeks ago
.gitignore 不再提交生成的文件页 2 weeks ago
Chrome插件.md 代理助手:proxy-switchyomega添加GitHub地址 3 weeks ago
Git.md 优化格式 5 days ago
Markdown编辑器.md 给独立页面添加YAML front matter侧边栏sidebar: auto 2 months ago
README.md 修改首页 2 weeks ago
README语法.md 语法增加多行文本 1 month ago
package.json 更新依赖 4 days ago
yarn.lock 更新依赖 4 days ago

README.md


home: true //heroImage: /hero.png actionText: 快速上手 → actionLink: /#命令 features:

  • title: 简单自由 details: 随意创建目录,编译时自动帮你配置菜单栏和侧边栏,最多三层目录结构。
  • title: Vue驱动 details: 享受 Vue + webpack 的开发体验,可以在 Markdown 中使用 Vue 组件,又可以使用 Vue 来开发自定义主题。 footer: MIT Licensed | Copyright © 2019 Bajins ---

使用

::: tip 基于本仓库可快速创建你自己的文档网站。 高亮语法支持列表 :::

目录结构

// 官方标准目录结构 https://v1.vuepress.vuejs.org/zh/guide/directory-structure.html
.
│  package-lock.json NPM依赖配置文件
│  package.json      项目配置文件
│  README.md         首页md文件
│  yarn.lock         yarn依赖配置文件
│  
├─.vuepress         用于存放VuePress的配置、组件、静态资源等。
│  │  config.js     VuePress配置
│  │  nav.js        除创建的目录之外,还可以自定义添加导航栏
│  │  utils.js      侧边栏和菜单栏自动配置工具
│  │  
│  └─public        静态资源目录
│      │  
│      ├─icons     存放图标目录
│      │      
│      └─images    存放所有文档的图片目录
├─docs              编译后的静态资源文件输出目录
│
│
...... 其他自己的md文档或文件夹,都会打包到docs文件夹下,md文件会编译成html

也就是你只需要遵从以上目录结构来修改你自己的文档即可使用。

::: warning 注意 配置文件中的注释文字部分,请结合VuePress官方文档一定理解其意义再修改配置! :::

命令

# 先克隆本仓库
git clone https://github.com/woytu/UseNotes.git

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

# 使用前请自行安装Node.js环境
# 安装yarn
npm install -g yarn

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

# 这时创建并书写你自己的文档
# 再配置.vuepress/nav.js和.vuepress/sidebar.js两个文件

# 开始运行开发环境,然后访问窗口中的路径
yarn dev


# 构建静态文件并上传到仓库正式使用
yarn build

# 如果是直接发布到本仓库,那么就把docs文件夹下的所有文件都push,
# 然后再在GitHub设置中指定Source为docs文件夹

# 可以把编译后的静态文件部署到指定仓库
cd /docs
git init
git add -A
git commit -m 'deploy'

# 如果发布到 https://<USERNAME>.github.io
git push -f https://github.com/<USERNAME>/<USERNAME>.github.io.git master

# 如果发布到 https://<USERNAME>.github.io/<REPO>
git push -f https://github.com/<USERNAME>/<REPO>.git master:gh-pages

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