Skip to content

Commit 6d47e86

Browse files
committed
chore: use idoc build website.
1 parent 369394c commit 6d47e86

File tree

9 files changed

+99
-14
lines changed

9 files changed

+99
-14
lines changed

.github/workflows/ci.yml

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,47 @@ jobs:
1414
node-version: 14
1515

1616
- run: npm install
17-
- run: node scripts/build.mjs
17+
- run: npm run build
1818

1919
- name: Generate Contributors Images
2020
uses: jaywcjlove/github-action-contributors@main
2121
with:
2222
filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\])
23-
output: build/CONTRIBUTORS.svg
23+
output: dist/CONTRIBUTORS.svg
2424
avatarSize: 42
2525

26-
- name: Deploy
26+
- name: Create Tag
27+
id: create_tag
28+
uses: jaywcjlove/create-tag-action@v1.3.6
29+
with:
30+
package-path: ./package.json
31+
32+
- name: Deploy Website
2733
uses: peaceiris/actions-gh-pages@v3
2834
with:
29-
github_token: ${{ secrets.GITHUB_TOKEN }}
30-
publish_dir: ./build
3135
user_name: 'github-actions[bot]'
32-
user_email: 'github-actions[bot]@users.noreply.github.com'
36+
user_email: 'github-actions[bot]@users.noreply.github.com'
37+
commit_message: ${{steps.tag_version.outputs.tag}} ${{ github.event.head_commit.message }}
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ./dist
40+
41+
- name: Generate Changelog
42+
id: changelog
43+
uses: jaywcjlove/changelog-generator@v1.5.3
44+
with:
45+
token: ${{ secrets.GITHUB_TOKEN }}
46+
filter-author: (jaywcjlove|小弟调调™|dependabot\[bot\]|Renovate Bot)
47+
filter: (^[\s]+?[R|r]elease)|(^[R|r]elease)
48+
49+
- name: Create Release
50+
uses: ncipollo/release-action@v1
51+
if: steps.create_tag.outputs.successful
52+
with:
53+
token: ${{ secrets.GITHUB_TOKEN }}
54+
name: ${{ steps.create_tag.outputs.version }}
55+
tag: ${{ steps.create_tag.outputs.version }}
56+
body: |
57+
Documentation ${{ steps.changelog.outputs.tag }}: https://raw.githack.com/jaywcjlove/mysql-tutorial/${{ steps.changelog.outputs.gh-pages-short-hash }}/index.html
58+
Comparing Changes: ${{ steps.changelog.outputs.compareurl }}
59+
60+
${{ steps.changelog.outputs.changelog }}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
#
33
.DS_Store
44

5+
dist
56
build
67
node_modules
78
npm-debug.log

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11

22
<img align="right" height="150" src="./img/mysql-logo.png">
33

4+
<!--idoc:ignore:start-->
45
MySQL入门教程
56
===
7+
<!--idoc:ignore:end-->
68

79
[![](https://jaywcjlove.github.io/sb/ico/mysql.svg)](http://www.mysql.com/) [![](https://jaywcjlove.github.io/sb/ico/awesome.svg)](awesome-mysql.md) [![](https://jaywcjlove.github.io/sb/license/mit.svg)](#)
810

@@ -162,9 +164,7 @@ MariaDB,是 MySQL server 的一个由社区开发的分支,MariaDB大部分
162164

163165
从目录来看,看上去内容丰富,比较完整的介绍了 MySQL 数据库技术的教程,我不是`DBA`,我不是,正在看这篇文章的你,很可能也不是,不想误人子弟,在项目中应用了一段时间 MySQL,如果你是`DBA`请多多指教,文采不佳还望高抬贵手,不甚感激,小弟在这里给您鞠躬,欢迎给我纠错。
164166

165-
~~我想念一个女孩儿,实属无奈我得继续努力,好好读书做个有趣的人,完成我的“著作”,待我著作完成可否跟我约个会?~~
166-
167-
还没有写完就结婚了,欢迎大家 PR 补充完善 :)。
167+
~~我想念一个女孩儿,实属无奈我得继续努力,好好读书做个有趣的人,完成我的“著作”,待我著作完成可否跟我约个会?~~ 还没有写完就结婚了,欢迎大家 PR 补充完善 :)。
168168

169169
## License
170170

docs/21-minutes-MySQL-basic-entry.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
为什么只需要21分钟呢?因为在我们大天朝有句话叫做三七二十一,你可以不管三七二十一开始使用 `MySQL` 及快速的方式入门 `MySQL`。其实21分钟把下面语句执行一遍是没有问题的,要理解的话估计不止21分钟,对于初学者来说只需满足自己需求可以增删改查等简易的维护即可。
55

6+
<!--idoc:ignore:start-->
7+
68
目录
79
---
810

@@ -51,6 +53,7 @@
5153
- [参考手册](#参考手册)
5254

5355
<!-- /TOC -->
56+
<!--idoc:ignore:end-->
5457

5558
## 开始使用
5659

docs/awesome-mysql.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Awesome MySQL
1212
![必备][bibei Icon] 表示**必备**资源标示;
1313
![1 star][red Icon] 表示强烈推荐的,星星的数量来表达强烈的程度;
1414

15+
<!--idoc:ignore:start-->
16+
1517
## 目录
1618

1719
- [手册文档](#手册文档)
@@ -22,6 +24,7 @@ Awesome MySQL
2224
- [官方资料](#官方资料)
2325
- [优秀文章](#优秀文章)
2426

27+
<!--idoc:ignore:end-->
2528

2629
## 手册文档
2730

@@ -102,7 +105,7 @@ _一些优秀的文章_
102105
* [一个不可思议的MySQL慢查分析与解决](http://fordba.com/optimize-an-amazing-mysql-slowlog.html)
103106

104107

105-
**[⬆ 返回顶部](#目录)**
108+
**[⬆ 返回顶部](#awesome-mysql)**
106109

107110

108111
[OSS Icon]: https://jaywcjlove.github.io/sb/ico/min-oss.svg

idoc.chapters.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
#### 第1章 初识 MySQL
3+
4+
- chapter1/: 第1章 初识 MySQL
5+
- chapter1/1.1.md: 数据库基础
6+
- chapter1/1.2.md: 数据库技术构成
7+
- chapter1/1.3.md: 什么是MySQL
8+
- chapter1/1.4.md: 如何学习MySQL
9+
10+
11+
#### 第2章 MySQL的安装与配置
12+
13+
- chapter2/: 第2章 MySQL 的安装与配置
14+
- chapter2/2.1.md: Mac平台下安装与配置MySQL
15+
- chapter2/2.2.md: Centos 平台安装与卸载MySQL
16+
- chapter2/2.3.md: Docker 安装 MySQL
17+
- chapter2/2.4.md: 启动数据库设置初始密码
18+
- chapter2/2.5.md: MySQL工具
19+
- chapter2/2.6.md: MySQL配置修改
20+
21+
22+
#### 第3章 数据库的基本操作
23+
24+
- chapter3/: 第3章 数据库的基本操作
25+
- chapter3/3.1.md: 连接数据库
26+
- chapter3/3.2.md: 查看选择数据库
27+
- chapter3/3.3.md: 创建数据库
28+
- chapter3/3.4.md: 删除数据库
29+
- chapter3/3.5.md: 数据库存储引擎

idoc.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
3+
logo: ./mysql.svg
4+
favicon: ./mysql.svg
5+
6+
menus:
7+
Home: index.html
8+
Cheat Sheet: 21-minutes-MySQL-basic-entry.html
9+
Awesome: awesome-mysql.html
10+
11+
editButton:
12+
label: Edit this page on GitHub
13+
url: https://github.com/jaywcjlove/mysql-tutorial/blob/master/
14+
15+
footer: |
16+
Released under the MIT License. Copyright © 2022 Kenny Wong<br />
17+
Generated by <a href="https://github.com/jaywcjlove/idoc" target="_blank">idoc</a> v{{idocVersion}}

mysql.svg

Lines changed: 4 additions & 0 deletions
Loading

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
{
22
"name": "mysql-tutorial",
33
"version": "0.0.1",
4+
"title": "MySQL 入门教程",
45
"description": "从零开始学习MySQL,主要是面向MySQL数据库管理系统初学者。",
56
"homepage": "https://jaywcjlove.github.io/mysql-tutorial",
67
"author": "jaywcjlove",
78
"license": "MIT",
89
"private": true,
910
"scripts": {
10-
"start": "node scripts/build.mjs"
11+
"start": "idoc --watch",
12+
"build": "idoc"
1113
},
1214
"repository": {
1315
"type": "git",
1416
"url": "git+https://github.com/jaywcjlove/mysql-tutorial.git"
1517
},
1618
"devDependencies": {
17-
"fs-extra": "^10.0.0",
18-
"markdown-to-html-cli": "^3.2.4",
19-
"recursive-readdir-files": "^2.0.7"
19+
"idoc": "^1.13.1"
2020
}
2121
}

0 commit comments

Comments
 (0)