https://github.com/bajins/notes-docsify
这是一个用docsify构建的文档
https://github.com/bajins/notes-docsify
docsify document
Last synced: about 2 months ago
JSON representation
这是一个用docsify构建的文档
- Host: GitHub
- URL: https://github.com/bajins/notes-docsify
- Owner: bajins
- Created: 2019-07-08T06:08:24.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-13T05:25:56.000Z (over 1 year ago)
- Last Synced: 2024-09-13T16:49:52.066Z (over 1 year ago)
- Topics: docsify, document
- Language: HTML
- Homepage: https://www.gotoxo.com
- Size: 28.3 MB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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、提交到仓库Windows脚本
│ push.sh 列出导航栏、侧边栏、files、提交到仓库Linux或Mac脚本
│
├─files 存放所有提供下载文件的文件夹
│
├─images 存放所有图片文件
│ │
│ └─icons 存放图标文件
│
...... 其他自己的md文档或文件夹
```
?> 只需遵从以上目录结构来修改你自己的文档即可使用。
!> 入口文件请结合[docsify官方文档](https://docsify.js.org)一定理解其意义再修改配置！
## 使用
- 先克隆本仓库 `git clone https://github.com/woytu/notes-docsify.git`
- 保留上面[目录结构](#目录结构)列出的文件和文件夹，其他的全部删除
- 创建自己的md文件，开始写作
- 编辑入口文件（`index.html`）
> 其中评论系统有多个例子，可自行修改
>
> 注意`basePath`配置项，如果repo不是githu.io访问根目录，则不能使用`/`
- Windows添加hook
- 在项目中打开CMD执行`(echo #!/bin/bash& echo.& echo ./push.sh)>.git/hooks/pre-commit`
- 或者`(for %i in ("#!/bin/bash" "./push.sh") do @echo %~i&@echo.)>.git/hooks/pre-commit`
- 在PowerShell中执行echo "#!/bin/bash`n./push.sh"| Out-File .git/hooks/pre-commit -encoding ASCII
> Windows下脚本没有写权限：在`git-bash.exe`文件或快捷方式上鼠标`右键` -> `属性` -> `兼容性` -> 勾选`以管理员身份运行此程序` -> `确定`
- Linux或Mac添加hook
- 在项目中执行`echo -e '#!/bin/bash\n\n./push.sh'>.git/hooks/pre-commit`
- 如果提示`-bash: !": event not found`执行`chmod +x .git/hooks/pre-commit`设置权限
- 提交（`commit`）并推送（`push`）到远程
- 提交后到GitHub设置中开启`GitHub Pages`