Skip to content

Commit

Permalink
add vuepress framework
Browse files Browse the repository at this point in the history
  • Loading branch information
gdut-yy committed Aug 25, 2020
1 parent 65a7d73 commit 6db5af9
Show file tree
Hide file tree
Showing 8 changed files with 164 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/
docs/.vuepress/dist/
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018-present, Yuxi (Evan) You

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# JavaScript-The-Definitive-Guide-7th-zh

《JavaScript 权威指南第七版》中文翻译

在线阅读:[http://gdut_yy.gitee.io/doc-jstdg7/](http://gdut_yy.gitee.io/doc-jstdg7/)

<img src="./docs/cover.jpg" width=24% />

## 目录

- [第 1 章 JavaScript 概述](docs/ch1.md)
- [第 2 章 词法结构](docs/ch2.md)
- [第 3 章 类型、值和变量](docs/ch3.md)
- [第 4 章 表达式和运算符](docs/ch4.md)
- [第 5 章 语句](docs/ch5.md)
- [第 6 章 对象](docs/ch6.md)
- [第 7 章 数组](docs/ch7.md)
- [第 8 章 函数](docs/ch8.md)
- [第 9 章 类](docs/ch9.md)
- [第 10 章 模块](docs/ch10.md)
- [第 11 章 JavaScript 标准库](docs/ch11.md)
- [第 12 章 迭代器和生成器](docs/ch12.md)
- [第 13 章 异步 JavaScript](docs/ch13.md)
- [第 14 章 元编程](docs/ch14.md)
- [第 15 章 Web 浏览器中的 JavaScript](docs/ch15.md)
- [第 16 章 服务器端 JavaScript](docs/ch16.md)
- [第 17 章 JavaScript 工具和扩展](docs/ch17.md)

## 本地开发 & 阅读

本项目基于 vuepress 进行开发,以提供比 github mardown 更佳的阅读体验

依赖于 `node.js``yarn``vuepress` 等环境

```sh
# vuepress
yarn global add vuepress

# 本地开发
git clone https://github.com/gdut-yy/JavaScript-The-Definitive-Guide-7th-zh.git
cd JavaScript-The-Definitive-Guide-7th-zh/
yarn docs:dev
```

## 更多书籍

[https://github.com/xx-zh/xx-zh-roadmap](https://github.com/xx-zh/xx-zh-roadmap)

## License

[MIT](./LICENSE)
38 changes: 38 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// .vuepress/config.js
module.exports = {
title: "《JavaScript 权威指南第七版》中文翻译",
base: "/doc-jstdg7/",
themeConfig: {
repo: "gdut-yy/JavaScript-The-Definitive-Guide-7th-zh",
repoLabel: "Github",
docsRepo: "gdut-yy/JavaScript-The-Definitive-Guide-7th-zh",
docsBranch: "master/docs",
editLinks: true,
editLinkText: "帮助我们改善此页面!",
lastUpdated: "Last Updated",
sidebarDepth: 2,
nav: [],
sidebar: {
"/": [
"",
"ch1.md",
"ch2.md",
"ch3.md",
"ch4.md",
"ch5.md",
"ch6.md",
"ch7.md",
"ch8.md",
"ch9.md",
"ch10.md",
"ch11.md",
"ch12.md",
"ch13.md",
"ch14.md",
"ch15.md",
"ch16.md",
"ch17.md",
],
},
},
};
21 changes: 21 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 目录

<img src="./cover.jpg" style="width: 28%" />

- [第 1 章 JavaScript 概述](./ch1.md)
- [第 2 章 词法结构](./ch2.md)
- [第 3 章 类型、值和变量](./ch3.md)
- [第 4 章 表达式和运算符](./ch4.md)
- [第 5 章 语句](./ch5.md)
- [第 6 章 对象](./ch6.md)
- [第 7 章 数组](./ch7.md)
- [第 8 章 函数](./ch8.md)
- [第 9 章 类](./ch9.md)
- [第 10 章 模块](./ch10.md)
- [第 11 章 JavaScript 标准库](./ch11.md)
- [第 12 章 迭代器和生成器](./ch12.md)
- [第 13 章 异步 JavaScript](./ch13.md)
- [第 14 章 元编程](./ch14.md)
- [第 15 章 Web 浏览器中的 JavaScript](./ch15.md)
- [第 16 章 服务器端 JavaScript](./ch16.md)
- [第 17 章 JavaScript 工具和扩展](./ch17.md)
Binary file added docs/cover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions gitee-deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#!/usr/bin/env sh

# abort on errors
set -e

# build
yarn docs:build

# navigate into the build output directory
cd docs/.vuepress/dist

# if you are deploying to a custom domain
echo 'http://gdut_yy.gitee.io/doc-jstdg7/' > CNAME

git init
git add -A
git commit -m 'deploy'

# if you are deploying to https://<USERNAME>.github.io
git push -f [email protected]:gdut_yy/doc-jstdg7.git master

# if you are deploying to https://<USERNAME>.github.io/<REPO>
# git push -f [email protected]:<USERNAME>/<REPO>.git master:gh-pages

cd -
6 changes: 6 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"scripts": {
"docs:dev": "vuepress dev docs --open --host 127.0.0.1",
"docs:build": "vuepress build docs"
}
}

0 comments on commit 6db5af9

Please sign in to comment.