Files
2020-08-18 21:57:27 +08:00

73 lines
1.8 KiB
Markdown

# 咕咕笔记
> 这里是小咕可可爱爱的笔记们~
### 相关文件说明
- **_coverpage.md**
![image-20200818214130070](README.assets/image-20200818214130070.png)
网站首页显示的内容,可以在这个文件进行修改。
- **_sidebar**
![image-20200818214158420](README.assets/image-20200818214158420.png)
侧边栏的内容,该内容由脚本自动生成。
- **scripts**
该文件夹下放置了若干配置和脚本
- `README.md`
网站的简介,点击封面的 `Getting start` 之后跳转到的界面
### 基本使用
- 第一次使用先clone项目
```bash
git clone https://gitea.qjm253.cn/baihe/gugu-note.git
```
- 接着可以在项目目录下建立若干个文件夹,每个文件夹都会在侧边栏生成一行加粗的目录行,可以通过将笔记放在不同文件夹下对笔记进行分类。
![image-20200818214737813](README.assets/image-20200818214737813.png)
- 本地预览
```bash
docsify serve
```
然后浏览器打开:[http://localhost:3000](http://localhost:3000) 进行预览。
**之后直接更新md文件,保存之后网站会实时重新渲染**
- 每次新增文件或者文件夹之后,要在项目根目录执行以下命令:
```bash
./gugu.sh update
```
这样会自动分析当前的目录结构,生成侧边栏菜单配置,同时将当前项目下所有 md 文件的内容都加入到本地检索当中,这样便可以在搜索框搜索所有文件的任意内容:
![image-20200818215223910](README.assets/image-20200818215223910.png)
- 云端部署
用户名:baihe
密码:Bh0829,
```bash
./gugu.sh deploy
```
部署到云端之后,可以通过访问 [https://gugunote.qjm253.cn](https://gugunote.qjm253.cn) 在线查看笔记