add docisfy support

* now you can view doc via browswer with `make`
This commit is contained in:
Vonng 2021-08-10 11:24:18 +08:00
parent 23277ef773
commit 552259bf3b
10 changed files with 152 additions and 21 deletions

14
Makefile Normal file
View File

@ -0,0 +1,14 @@
default: serve
# serve document with docsify (or python)
s: serve
d: serve
serve:
bin/serve
# generate zh-tw version
translate:
bin/zh-tw.py
.PHONY: s d serve translate

View File

@ -1,14 +1,11 @@
# 设计数据密集型应用 - 中文翻译
- 作者: [Martin Kleppmann](https://martin.kleppmann.com)
- 原书名称:[《Designing Data-Intensive Applications》](http://shop.oreilly.com/product/0636920032175.do)
- 译者:[冯若航]( http://vonng.com/about) fengruohang@outlook.com
- Gitbook地址[ddia-cn](https://vonng.gitbooks.io/ddia-cn)
- 使用[Typora](https://www.typora.io)或Gitbook以获取最佳阅读体验。
* [繁體中文版本](zh-tw/README.md)
- 原名:[《Designing Data-Intensive Applications》](http://shop.oreilly.com/product/0636920032175.do)
- 译者:[冯若航]( https://vonng.com) rh@vonng.com
- 使用 [Typora](https://www.typora.io)、[Gitbook](https://vonng.gitbooks.io/ddia-cn/content/),以及[Docsify](https://docsify.js.org/#/zh-cn/)以获取最佳阅读体验。
- 繁体:[繁體中文版本](zh-tw/README.md)
- 执行 `make`可以通过浏览器阅读
## 译序

6
_coverpage.md Normal file
View File

@ -0,0 +1,6 @@
# 设计数据密集型应用 <small></small>
> <b>Designing Data Intensive Applications</b>

3
_navbar.md Normal file
View File

@ -0,0 +1,3 @@
- Language
- [:cn: 简体](/)
- [:cn: 繁体](/zh-tw/)

11
bin/serve Executable file
View File

@ -0,0 +1,11 @@
#!/bin/bash
PROG_DIR="$(cd $(dirname $0) && pwd)"
HOME_DIR="$(cd $(dirname ${PROG_DIR}) && pwd)"
if command -v docsify; then
cd ${HOME_DIR} && docsify serve
else
cd ${HOME_DIR} && python -m SimpleHTTPServer 3001
echo "open http://localhost:3001 with your browser"
fi

66
index.html Normal file
View File

@ -0,0 +1,66 @@
<!DOCTYPE html>
<html lang="zh-cn">
<head>
<meta charset="UTF-8" />
<title>设计数据密集型应用</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="keywords" content="设计数据密集型应用"/>
<meta name="description" content="A magical documentation generator." />
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css" title="vue"/>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/dark.css" title="dark" disabled/>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/buble.css" title="buble" disabled/>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/pure.css" title="pure" disabled/>
</head>
<body>
<div id="app">Loading ...</div>
<script>
// Set html "lang" attribute based on URL
var lang = location.hash.match(/#\/(zh-cn)\//);
if (lang) {
document.documentElement.setAttribute('lang', lang[1]);
}
// configuration
window.$docsify = {
name: '设计数据密集型应用',
repo: 'Vonng/ddia',
auto2top: true,
coverpage: true,
executeScript: true,
loadSidebar: true,
loadNavbar: true,
mergeNavbar: true,
relativePath: true,
maxLevel: 4,
subMaxLevel: 3,
alias: {
'/.*/_navbar.md': '/_navbar.md',
'/.*/_cover.md': '/_navbar.md',
},
search: {
maxAge: 10000,
paths: 'auto',
noData: {
'/': '没有结果!',
'/zh-tw/': '沒有結果!',
},
placeholder: {
'/': '搜索',
'/zh-tw/': '搜索',
},
pathNamespaces: ['/zh-tw']
},
plugins: [],
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-markdown.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-nginx.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/vue@2/dist/vue.min.js"></script>
</body>
</html>

View File

@ -4,19 +4,13 @@
- 作者: [Martin Kleppmann](https://martin.kleppmann.com)
- 原[《Designing Data-Intensive Applications》](http://shop.oreilly.com/product/0636920032175.do)
- 原名:[《Designing Data-Intensive Applications》](http://shop.oreilly.com/product/0636920032175.do)
- 譯者:[馮若航]( http://vonng.com/about) fengruohang@outlook.com
- Gitbook地址[ddia-cn](https://vonng.gitbooks.io/ddia-cn)
- 使用[Typora](https://www.typora.io)或Gitbook以獲取最佳閱讀體驗。
* [繁體中文版本](zh-tw/README.md)
- 譯者:[馮若航]( https://vonng.com) rh@vonng.com
- 使用 [Typora](https://www.typora.io)、[Gitbook](https://vonng.gitbooks.io/ddia-cn/content/),以及[Docsify](https://docsify.js.org/#/zh-cn/)以獲取最佳閱讀體驗。
- 繁體:[繁體中文版本](zh-tw/README.md)

11
zh-tw/_coverpage.md Normal file
View File

@ -0,0 +1,11 @@
# 設計資料密集型應用 <small></small>
> <b>Designing Data Intensive Applications</b>

5
zh-tw/_navbar.md Normal file
View File

@ -0,0 +1,5 @@
- Language
- [:cn: 簡體](/)
- [:cn: 繁體](/zh-tw/)

View File

@ -1,23 +1,47 @@
- [序言](preface.md)
- [第一部分:資料系統的基石](part-i.md)
- [第一章:可靠性、可伸縮性、可維護性](ch1.md)
- [第二章:資料模型與查詢語言](ch2.md)
- [第三章:儲存與檢索](ch3.md)
- [第四章:編碼與演化](ch4.md)
- [第二部分:分散式資料](part-ii.md)
- [第五章:複製](ch5.md)
- [第六章:分割槽](ch6.md)
- [第七章:事務](ch7.md)
- [第八章:分散式系統的麻煩](ch8.md)
- [第九章:一致性與共識](ch9.md)
- [第三部分:衍生資料](part-iii.md)
- [第十章:批處理](ch10.md)
- [第十一章:流處理](ch11.md)
- [第十二章:資料系統的未來](ch12.md)
- [術語表](glossary.md)
- [後記](colophon.md)