Skip to content

Commit 3bb5565

Browse files
committed
✨ 使用 gitbook 管理文档
1 parent e6d94f7 commit 3bb5565

File tree

8 files changed

+264
-16
lines changed

8 files changed

+264
-16
lines changed

.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

.gitattributes

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
* text=auto eol=lf
2+
3+
# plan text
4+
*.txt text
5+
*.java text
6+
*.scala text
7+
*.groovy text
8+
*.gradle text
9+
*.xml text
10+
*.xsd text
11+
*.tld text
12+
*.yaml text
13+
*.yml text
14+
*.wsdd text
15+
*.wsdl text
16+
*.jsp text
17+
*.jspf text
18+
*.js text
19+
*.jsx text
20+
*.json text
21+
*.css text
22+
*.less text
23+
*.sql text
24+
*.properties text
25+
26+
# unix style
27+
*.sh text eol=lf
28+
29+
# win style
30+
*.bat text eol=crlf
31+
32+
# don't handle
33+
*.der -text
34+
*.jks -text
35+
*.pfx -text
36+
*.map -text
37+
*.patch -text
38+
*.dat -text
39+
*.data -text
40+
*.db -text
41+
42+
# binary
43+
*.jar binary
44+
*.war binary
45+
*.zip binary
46+
*.tar binary
47+
*.tar.gz binary
48+
*.gz binary
49+
*.apk binary
50+
*.bin binary
51+
*.exe binary
52+
53+
# 图片
54+
*.png binary
55+
*.jpg binary
56+
*.ico binary
57+
*.gif binary
58+
59+
# 音视频
60+
*.mp3 binary
61+
*.swf binary
62+
63+
# 字体
64+
*.eot binary
65+
*.svg binary
66+
*.ttf binary
67+
*.woff binary
68+
69+
# other doc
70+
*.pdf binary
71+
*.doc binary
72+
*.docx binary
73+
*.xls binary
74+
*.xlsx binary
75+
*.xmind binary

.gitignore

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,38 @@
1-
# Compiled class file
1+
################ JAVA ################
2+
# temp folders
3+
classes
4+
target
5+
logs
6+
7+
# temp files
28
*.class
9+
*.jar
10+
*.war
11+
312

4-
# Log file
13+
################ JAVASCRIPT ################
14+
# dependencies
15+
node_modules
16+
17+
# temp folders
18+
build
19+
dist
20+
_book
21+
_jsdoc
22+
23+
# temp files
524
*.log
25+
npm-debug.log*
26+
yarn-debug.log*
27+
yarn-error.log*
28+
bundle*.js
629

7-
# BlueJ files
8-
*.ctxt
930

10-
# Mobile Tools for Java (J2ME)
11-
.mtj.tmp/
31+
################ IDEA ################
32+
.idea
33+
*.iml
1234

13-
# Package Files #
14-
*.jar
15-
*.war
16-
*.ear
17-
*.zip
18-
*.tar.gz
19-
*.rar
2035

21-
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
22-
hs_err_pid*
36+
################ Eclipse ################
37+
.classpath
38+
.project

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,14 @@
11
# algorithm-notes
2-
:books: 算法学习笔记
2+
3+
<p align="center">
4+
:book: 算法+数据结构学习笔记
5+
</p>
6+
7+
<p align="center">
8+
<img src="http://upload-images.jianshu.io/upload_images/3101171-978babefd01de63e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" alt="Blog" width="640">
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://dunwu.gitbooks.io/algorithm-notes/" target="_blank">:point_right: 查看算法+数据结构学习笔记</a>
13+
</p>
14+

book.json

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
{
2+
"gitbook": "3.2.2",
3+
"title": "algorithm-notes",
4+
"description": "算法+数据结构学习笔记",
5+
"author": "Zhang Peng",
6+
"language": "zh-hans",
7+
"root": "./docs",
8+
"links": {
9+
"sidebar": {
10+
"algorithm-notes": "https://github.com/dunwu/algorithm-notes"
11+
}
12+
},
13+
"plugins": [
14+
"-lunr",
15+
"-search",
16+
"advanced-emoji@^0.2.2",
17+
"anchor-navigation-ex@1.0.10",
18+
"anchors@^0.7.1",
19+
"edit-link@^2.0.2",
20+
"expandable-chapters-small@^0.1.7",
21+
"github@^2.0.0",
22+
"search-plus@^0.0.11",
23+
"simple-page-toc@^0.1.1",
24+
"splitter@^0.0.8",
25+
"tbfed-pagefooter@^0.0.1"
26+
],
27+
"pluginsConfig": {
28+
"anchor-navigation-ex": {
29+
"showLevel": false,
30+
"associatedWithSummary": true,
31+
"multipleH1": true,
32+
"mode": "float",
33+
"isRewritePageTitle": false,
34+
"float": {
35+
"showLevelIcon": false,
36+
"level1Icon": "fa fa-hand-o-right",
37+
"level2Icon": "fa fa-hand-o-right",
38+
"level3Icon": "fa fa-hand-o-right"
39+
},
40+
"pageTop": {
41+
"showLevelIcon": false,
42+
"level1Icon": "fa fa-hand-o-right",
43+
"level2Icon": "fa fa-hand-o-right",
44+
"level3Icon": "fa fa-hand-o-right"
45+
}
46+
},
47+
"edit-link": {
48+
"base": "https://github.com/dunwu/algorithm-notes/blob/master/docs/",
49+
"label": "编辑此页面"
50+
},
51+
"github": {
52+
"url": "https://github.com/dunwu"
53+
},
54+
"simple-page-toc": {
55+
"maxDepth": 4,
56+
"skipFirstH1": true
57+
},
58+
"sharing": {
59+
"weibo": true,
60+
"all": [
61+
"weibo"
62+
]
63+
},
64+
"tbfed-pagefooter": {
65+
"copyright": "Copyright © Zhang Peng 2016-2017",
66+
"modify_label": "该文件上次修订时间:",
67+
"modify_format": "YYYY-MM-DD HH:mm:ss"
68+
}
69+
}
70+
}

docs/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# algorithm-notes
2+
3+
<p align="center">
4+
:book: 算法+数据结构学习笔记
5+
</p>
6+
7+
<p align="center">
8+
<img src="http://upload-images.jianshu.io/upload_images/3101171-978babefd01de63e.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" alt="Blog" width="640">
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://dunwu.gitbooks.io/algorithm-notes/" target="_blank">:point_right: 查看算法+数据结构学习笔记</a>
13+
</p>
14+

docs/SUMMARY.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Summary
2+
3+
* [自述](README.md)
4+
5+
------
6+

package.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"name": "algorithm-notes",
3+
"description": "算法+数据结构学习笔记",
4+
"scripts": {
5+
"clean": "rimraf _book",
6+
"prepare": "gitbook install",
7+
"build": "gitbook build ./ --log=debug --debug",
8+
"start": "gitbook serve"
9+
},
10+
"repository": {
11+
"type": "git",
12+
"url": "https://github.com/dunwu/algorithm-notes.git"
13+
},
14+
"author": "Zhang Peng <forbreak@163.com>",
15+
"license": "MIT",
16+
"bugs": {
17+
"url": "https://github.com/dunwu/algorithm-notes/issues"
18+
},
19+
"homepage": "https://github.com/dunwu/algorithm-notes",
20+
"devDependencies": {
21+
"gitbook-cli": "^2.3.2",
22+
"rimraf": "^2.6.1"
23+
}
24+
}

0 commit comments

Comments
 (0)