https://github.com/xy-plus/webdoc

https://github.com/xy-plus/webdoc

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/xy-plus/webdoc
• Owner: xy-plus
• Created: 2019-10-09T08:00:15.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-19T12:37:29.000Z (about 5 years ago)
• Last Synced: 2024-08-03T01:39:22.916Z (6 months ago)
• Language: Shell
• Size: 3.67 MB
• Stars: 4
• Watchers: 1
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# build web doc

用于构建含评论区（与 GitHub issue 关联）的 GitHun Page 的教程，文档已通过网页形式部署于：https://xy-plus.github.io/webdoc/

## 快速构建

执行以下命令：

```sh

git clone https://github.com/xy-plus/webdoc.git

cd webdoc

gitbook install

gitbook serve

```

然后访问：http://localhost:4000 即可。

> 注意：此时你看到的评论区链接的是我的 GitHub issue ，如果试图登录会跳转至本文部署的页面，而非 localhost 。

如果你需要将评论区改为关联到自己的 GitHub issue ，请阅读 **3.2 评论区** 和 **4. 部署网页** 。