Skip to content

Commit cefb56f

Browse files
authored
refine docs and sync language-highlight.md (#21)
1 parent 81bc29b commit cefb56f

File tree

3 files changed

+60
-20
lines changed

3 files changed

+60
-20
lines changed

README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
## docsify
22

3-
> 一个神奇的文档网站生成工具
3+
> 一个神奇的文档网站生成器。
44
5-
## 是什么
5+
## 概述
66

7-
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件,所有转换工作都是在运行时进行。
8-
9-
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 `.html` 文件“污染” commit 记录,只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy.md)
7+
docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是它不会生成静态的 `.html` 文件,所有转换工作都是在运行时。如果你想要开始使用它,只需要创建一个 `index.html` 就可以开始编写文档并直接[部署在 GitHub Pages](zh-cn/deploy.md)
108

119
查看[快速开始](zh-cn/quickstart.md)了解详情。
1210

@@ -21,9 +19,9 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo
2119
- 兼容 IE11
2220
- 支持服务端渲染 SSR ([示例](https://github.com/docsifyjs/docsify-ssr-demo))
2321

24-
## 例子
22+
## 示例
2523

26-
可以查看 [Showcase](https://github.com/docsifyjs/docsify/#showcase) 来了解使用 docsify 的文档项目。
24+
可以查看 [Showcase](https://github.com/docsifyjs/docsify/#showcase) 来了解更多在使用 docsify 的文档项目。
2725

2826
## 捐赠
2927

language-highlight.md

+47-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,53 @@
11
# 代码高亮
22

3-
内置的代码高亮工具是 [Prism](https://github.com/PrismJS/prism),默认支持 CSS、JavaScript 和 HTML。如果需要高亮其他语言,例如`PHP`,可以手动引入代码高亮插件。
3+
**docsify**内置的代码高亮工具是 [Prism](https://github.com/PrismJS/prism)。Prism 默认支持的语言如下:
4+
5+
* Markup - `markup`, `html`, `xml`, `svg`, `mathml`, `ssml`, `atom`, `rss`
6+
* CSS - `css`
7+
* C-like - `clike`
8+
* JavaScript - `javascript`, `js`
9+
10+
[添加额外的语法支持](https://prismjs.com/#supported-languages)需要通过CDN添加相应的[语法文件](https://cdn.jsdelivr.net/npm/prismjs@1/components/) :
411

512
```html
6-
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
7-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-bash.min.js"></script>
8-
<script src="//cdn.jsdelivr.net/npm/prismjs/components/prism-php.min.js"></script>
13+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
14+
<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
915
```
1016

11-
?> 其他的语言高亮插件可以查看[Prims 仓库](https://github.com/PrismJS/prism/tree/gh-pages/components)
17+
要使用语法高亮,需要在代码块第一行添加对应的[语言声明](https://prismjs.com/#supported-languages),示例如下:
18+
19+
````
20+
```html
21+
<p>This is a paragraph</p>
22+
<a href="//docsify.js.org/">Docsify</a>
23+
```
24+
25+
```bash
26+
echo "hello"
27+
```
28+
29+
```php
30+
function getAdder(int $x): int
31+
{
32+
return 123;
33+
}
34+
```
35+
````
36+
37+
上面代码的渲染结果:
38+
39+
```html
40+
<p>This is a paragraph</p>
41+
<a href="//docsify.js.org/">Docsify</a>
42+
```
43+
44+
```bash
45+
echo "hello"
46+
```
47+
48+
```php
49+
function getAdder(int $x): int
50+
{
51+
return 123;
52+
}
53+
```

quickstart.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 快速开始
22

3-
推荐安装 `docsify-cli` 工具,可以方便创建及本地预览文档网站
3+
推荐全局安装 `docsify-cli` 工具,可以方便地创建及在本地预览生成的文档
44

55
```bash
66
npm i docsify-cli -g
@@ -20,13 +20,13 @@ docsify init ./docs
2020

2121
- `index.html` 入口文件
2222
- `README.md` 会做为主页内容渲染
23-
- `.nojekyll` 用于阻止 GitHub Pages 会忽略掉下划线开头的文件
23+
- `.nojekyll` 用于阻止 GitHub Pages 忽略掉下划线开头的文件
2424

25-
直接编辑 `docs/README.md` 就能更新网站内容,当然也可以[写多个页面](zh-cn/more-pages.md)
25+
直接编辑 `docs/README.md` 就能更新文档内容,当然也可以[添加更多页面](zh-cn/more-pages.md)
2626

27-
## 本地预览网站
27+
## 本地预览
2828

29-
运行一个本地服务器通过 `docsify serve` 可以方便的预览效果,而且提供 LiveReload 功能,可以让实时的预览。默认访问 http://localhost:3000
29+
通过运行 `docsify serve` 启动一个本地服务器,可以方便地实时预览效果。默认访问地址 http://localhost:3000
3030

3131
```bash
3232
docsify serve docs
@@ -36,7 +36,7 @@ docsify serve docs
3636

3737
## 手动初始化
3838

39-
如果不喜欢 npm 或者觉得安装工具太麻烦,我们其实只需要直接创建一个 `index.html` 文件。
39+
如果不喜欢 npm 或者觉得安装工具太麻烦,我们可以直接手动创建一个 `index.html` 文件。
4040

4141
*index.html*
4242

@@ -61,7 +61,7 @@ docsify serve docs
6161
</html>
6262
```
6363

64-
如果系统里安装 Python 的话,也可以很轻易的启动一个静态服务器
64+
如果你的系统里安装了 Python 的话,也可以很容易地启动一个静态服务器去预览你的网站
6565

6666
```bash
6767
cd docs && python -m SimpleHTTPServer 3000
@@ -91,4 +91,4 @@ cd docs && python -m SimpleHTTPServer 3000
9191
</script>
9292
```
9393

94-
对比 [el 设置](configuration.md#el)
94+
对比 [el 设置](configuration.md#el)

0 commit comments

Comments
 (0)