Skip to content

Commit f0a945f

Browse files
dunwudunwu
committed
📝 Writing docs.
1 parent f4ef14f commit f0a945f

12 files changed

Lines changed: 3087 additions & 68 deletions

‎.editorconfig‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# http://editorconfig.org
4+
# 所有文件换行使用 Unix like 风格（LF），bat 文件使用 win 风格（CRLF）
5+
# 缩进 java 4 个空格，其他所有文件 2 个空格
6+
7+
root = true
8+
9+
[*]
10+
# Unix-style newlines with a newline ending every file
11+
end_of_line = lf
12+
13+
# Change these settings to your own preference
14+
indent_size = 2
15+
indent_style = space
16+
max_line_length = 120
17+
18+
# We recommend you to keep these unchanged
19+
charset = utf-8
20+
trim_trailing_whitespace = true
21+
insert_final_newline = true
22+
23+
[*.bat]
24+
end_of_line = crlf
25+
26+
[*.java]
27+
indent_size = 4
28+
29+
[*.md]
30+
max_line_length = 0
31+
trim_trailing_whitespace = false

‎GLOSSARY.md‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎SUMMARY.md‎

Lines changed: 0 additions & 14 deletions
This file was deleted.

‎book.json‎

Lines changed: 6 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -4,43 +4,32 @@
44
"description": "个人的数据库学习笔记",
55
"author": "Zhang Peng",
66
"language": "zh-hans",
7+
"root": "./docs",
78
"links": {
89
"sidebar": {
910
"db-notes": "https://github.com/dunwu/db-notes"
1011
}
1112
},
1213
"plugins": [
13-
"-highlight",
14-
"-livereload",
1514
"-lunr",
1615
"-search",
1716
"advanced-emoji@^0.2.2",
18-
"anchor-navigation-ex@0.1.8",
17+
"anchor-navigation-ex@1.0.10",
1918
"anchors@^0.7.1",
20-
"disqus@^0.1.0",
2119
"edit-link@^2.0.2",
22-
"emphasize@^1.1.0",
2320
"expandable-chapters-small@^0.1.7",
24-
"favicon@^0.0.2",
2521
"github@^2.0.0",
26-
"include-codeblock@^3.0.2",
27-
"ace@^0.3.2",
28-
"katex@^1.1.3",
29-
"local-video@^1.0.1",
30-
"prism@^2.1.0",
31-
"prism-themes@^0.0.2",
3222
"search-plus@^0.0.11",
33-
"sectionx@^3.1.0",
3423
"simple-page-toc@^0.1.1",
35-
"sitemap-general@^0.1.1",
3624
"splitter@^0.0.8",
37-
"tbfed-pagefooter@^0.0.1",
38-
"todo@^0.1.3"
25+
"tbfed-pagefooter@^0.0.1"
3926
],
4027
"pluginsConfig": {
4128
"anchor-navigation-ex": {
4229
"showLevel": false,
4330
"associatedWithSummary": true,
31+
"multipleH1": true,
32+
"mode": "float",
4433
"isRewritePageTitle": false,
4534
"float": {
4635
"showLevelIcon": false,
@@ -55,53 +44,23 @@
5544
"level3Icon": "fa fa-hand-o-right"
5645
}
5746
},
58-
"disqus": {
59-
"shortName": "db-notes"
60-
},
6147
"edit-link": {
6248
"base": "https://github.com/dunwu/db-notes/blob/master",
6349
"label": "编辑此页面"
6450
},
65-
"favicon": {
66-
"shortcut": "assets/images/folder.ico",
67-
"bookmark": "assets/images/folder.ico"
68-
},
6951
"github": {
7052
"url": "https://github.com/dunwu/db-notes"
7153
},
72-
"include-codeblock": {
73-
"template": "ace",
74-
"unindent": true,
75-
"edit": true
76-
},
77-
"sectionx": {
78-
"tag": "b"
79-
},
8054
"simple-page-toc": {
8155
"maxDepth": 4,
8256
"skipFirstH1": true
8357
},
84-
"sitemap-general": {
85-
"prefix": "https://github.com/dunwu/db-notes"
86-
},
8758
"sharing": {
8859
"weibo": true,
89-
"facebook": true,
90-
"twitter": true,
91-
"google": false,
92-
"instapaper": false,
93-
"vk": false,
9460
"all": [
95-
"facebook",
96-
"google",
97-
"twitter",
98-
"weibo",
99-
"instapaper"
61+
"weibo"
10062
]
10163
},
102-
"theme-default": {
103-
"showLevel": true
104-
},
10564
"tbfed-pagefooter": {
10665
"copyright": "Copyright © Zhang Peng 2017",
10766
"modify_label": "该文件上次修订时间：",

‎docs/GLOSSARY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## NoSQL
2+
NoSQL，泛指非关系型的数据库。
3+
4+
## 关系数据库
5+
关系数据库，是建立在关系模型基础上的数据库，借助于集合代数等数学概念和方法来处理数据库中的数据。

‎docs/README.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# db-notes
2+
3+
​:books: 个人的数据库学习笔记。
4+
5+
**[gitbook 线上阅读](https://dunwu.gitbooks.io/db-notes/content/)**
6+
7+
## :memo: 内容
8+
9+
暂定计划为：完善所有本人使用过的 DB 的笔记：
10+
11+
**关系型数据库**
12+
- [ ] Mysql
13+
- [ ] Oracle
14+
- [ ] H2
15+
- [ ] Sqlite
16+
17+
**非关系型数据库**
18+
- [ ] MongoDB
19+
- [ ] Redis
20+
21+
22+
## :pushpin: 说明
23+
24+
本项目的文档按照 gitbook 规范编写，可以直接生成一个 gitbook 电子书站点。
25+
26+
如果想使用 gitbook 电子书，按以下步骤执行命令即可：
27+
28+
```bash
29+
# 1. 安装 gitbook-cli
30+
$ npm install -g gitbook-cli
31+
# 2. 安装 gitbook 各种依赖插件
32+
$ gitbook install
33+
# 3. 启动本地的 gitbook 电子书站点
34+
$ gitbook serve
35+
```
36+
37+
启动成功后，访问 http://localhost:4000 即可看到电子书了。

‎docs/SUMMARY.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Summary
2+
3+
## 简介
4+
5+
* [简介](README.md)
6+
7+
## sql 教程
8+
9+
* [Sql 快速指南](sql/sql-quickstart.md)
10+
* [Sql 约束](sql/sql-constraint.md)
11+
12+
------
13+
14+
* [术语](GLOSSARY.md)

docs/sql/sql约束.md renamed to docs/sql/sql-constraint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# sql 约束
1+
# Sql 约束
22

33
SQL 约束用于规定表中的数据规则。
44

docs/sql/sql语言基本语法.md renamed to docs/sql/sql-quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# sql 语言
1+
# Sql 快速指南
22

33
## DDL
44

0 commit comments

Comments
 (0)