Skip to content

Commit

Permalink
文档整理 fix Tencent#180
Browse files Browse the repository at this point in the history
  • Loading branch information
chexiongsheng committed Jul 18, 2017
1 parent 7309ca6 commit c923d65
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 24 deletions.
21 changes: 0 additions & 21 deletions docs/source/LICENSE

This file was deleted.

23 changes: 20 additions & 3 deletions docs/source/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,30 @@
# XLua 教程文档

这是XLua的教程文档网站,文档是使用[hexo](http://hexo.io/)构建的。 文档内容在src文件夹中,使用Markdown格式编写。
这是XLua的教程文档网站,文档是使用[hexo](http://hexo.io/)构建的。 文档内容在[src](src)文件夹中,使用Markdown格式编写。

## 搭建本地文档环境

首先您必须安装[nodejs](http://nodejs.cn/)安装完成后通过如下指令在 `localhost:4000` 启动文档网站:
* 首先您必须安装[nodejs](http://nodejs.cn/)[npm](https://www.npmjs.com/)

* 安装hexo,在docs/source下执行

```
$ npm install -g hexo-cli
$ npm install
```

* 如下指令在 `localhost:4000` 启动文档网站:

```
$ hexo server
```
```


## 修改Markdown后生成静态网页

* 已经安装了hexo的话,执行如下指令:

```
$ hexo g
```

0 comments on commit c923d65

Please sign in to comment.