# notes-docsify

**Repository Path**: woytu/notes-docsify

## Basic Information

- **Project Name**: notes-docsify
- **Description**: 这是一个用docsify构建的文档
- **Primary Language**: Shell
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://github.com/woytu/notes-docsify
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-07-25
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# Bajins

?> 基于本仓库可快速创建你自己的动态构建（只需要编写并提交，不需要手动编译成静态HTML）文档网站。[高亮语法支持列表](https://prismjs.com/#languages-list)


## 目录结构

```
.
│  .nojekyll        用于阻止 GitHub Pages 会忽略掉下划线开头的文件
│  files.md         列出files文件夹中的文件用于下载
│  index.html       入口文件
│  nav.md           导航栏
│  README.md        首页
│  sidebar.md       侧边栏
│  push.bat         列出导航栏、侧边栏、files、提交到仓库脚本
│      
├─files             存放所有提供下载文件的文件夹
│      
├─images            存放所有图片文件
│  │  
│  └─icons          存放图标文件
│
...... 其他自己的md文档或文件夹

```
?> 只需遵从以上目录结构来修改你自己的文档即可使用。

!> 入口文件请结合[docsify官方文档](https://docsify.js.org)一定理解其意义再修改配置！

## 使用


> 先克隆本仓库 `git clone https://github.com/woytu/UseNotes-docsify.git`

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

> 创建自己的md文件，开始写作

> 编辑入口文件（`index.html`）：其中评论系统有多个例子，可自行修改

> 使用`push 本次提交的备注信息`命令生成导航栏和文件列表，并且自动提交到仓库

> 提交后到GitHub设置中开启`GitHub Pages`