From a91d2dab67c8e36c108e206b38f9153a843802f0 Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Fri, 29 Jun 2018 22:22:14 +0800 Subject: [PATCH] docs: add gitter --- README.md | 36 +++++++++++++++++++----------------- docs/README.md | 20 ++++++++++++-------- docs/de-de/README.md | 20 ++++++++++++-------- docs/zh-cn/README.md | 20 ++++++++++++-------- 4 files changed, 55 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index b39628b..371a983 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ Travis Status npm donate + gitter

Glod Sponsor via Open Collective

@@ -26,21 +27,22 @@ ## Links -* [Documentation](https://docsify.js.org) -* [CLI](https://github.com/QingWei-Li/docsify-cli) -* CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) -* [Awesome docsify](https://github.com/QingWei-Li/awesome-docsify) +- [Documentation](https://docsify.js.org) +- [CLI](https://github.com/QingWei-Li/docsify-cli) +- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) +- [Awesome docsify](https://github.com/QingWei-Li/awesome-docsify) +- [Community chat](https://gitter.im/docsifyjs/Lobby) ## Features -* No statically built html files -* Simple and lightweight (~19kB gzipped) -* Smart full-text search plugin -* Multiple themes -* Useful plugin API -* Compatible with IE10+ -* Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) -* Support embedded files +- No statically built html files +- Simple and lightweight (~19kB gzipped) +- Smart full-text search plugin +- Multiple themes +- Useful plugin API +- Compatible with IE10+ +- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) +- Support embedded files ## Quick start @@ -61,11 +63,11 @@ Move to [awesome-docsify](https://github.com/QingWei-Li/awesome-docsify) ## Contributing -* Fork it! -* Create your feature branch: `git checkout -b my-new-feature` -* Commit your changes: `git commit -am 'Add some feature'` -* Push to the branch: `git push origin my-new-feature` -* Submit a pull request +- Fork it! +- Create your feature branch: `git checkout -b my-new-feature` +- Commit your changes: `git commit -am 'Add some feature'` +- Push to the branch: `git push origin my-new-feature` +- Submit a pull request ## Development diff --git a/docs/README.md b/docs/README.md index 579cbc4..bb3abe2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,15 +10,15 @@ See the [Quick start](quickstart.md) for more details. ## Features -* No statically built html files -* Simple and lightweight (~19kB gzipped) -* Smart full-text search plugin -* Multiple themes -* Useful plugin API -* Emoji support -* Compatible with IE10+ +- No statically built html files +- Simple and lightweight (~19kB gzipped) +- Smart full-text search plugin +- Multiple themes +- Useful plugin API +- Emoji support +- Compatible with IE10+ -- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) +* Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) ## Examples @@ -27,3 +27,7 @@ Check out the [Showcase](https://github.com/QingWei-Li/docsify/#showcase) to doc ## Donate Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart: + +## Community + +Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby). diff --git a/docs/de-de/README.md b/docs/de-de/README.md index d7092cd..adeaff2 100644 --- a/docs/de-de/README.md +++ b/docs/de-de/README.md @@ -10,15 +10,15 @@ Siehe [Schnellstart](de-de/quickstart.md) für weitere Informationen. ## Features -* keine generierten, statischen HTML Dateien -* einfach und klein (~19kB gzipped) -* smarte Erweiterung mit Volltextsuche -* mehrere Themes -* praktische API für Erweiterungen -* Unterstützung für Emoji -* Kompatibel mit IE10+ +- keine generierten, statischen HTML Dateien +- einfach und klein (~19kB gzipped) +- smarte Erweiterung mit Volltextsuche +- mehrere Themes +- praktische API für Erweiterungen +- Unterstützung für Emoji +- Kompatibel mit IE10+ -- Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) +* Support SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) ## Beispiele @@ -27,3 +27,7 @@ Vergleiche die Liste namens [Showcase](https://github.com/QingWei-Li/docsify/#sh ## Spenden Bitte ziehe eine Spende in Erwägung, sollte **docsify** dir hilfreich oder meine Arbeit dir wertvoll erscheinen. Ich freue mich, wenn du mir [eine Tasse Kaffee kaufst](https://github.com/QingWei-Li/donate). :heart: + +## Community + +Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby). diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 9bad6ff..1de6f5c 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -12,14 +12,14 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo ## 特性 -* 无需构建，写完文档直接发布 -* 容易使用并且轻量 (~19kB gzipped) -* 智能的全文搜索 -* 提供多套主题 -* 丰富的 API -* 支持 Emoji -* 兼容 IE10+ -* 支持 SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) +- 无需构建，写完文档直接发布 +- 容易使用并且轻量 (~19kB gzipped) +- 智能的全文搜索 +- 提供多套主题 +- 丰富的 API +- 支持 Emoji +- 兼容 IE10+ +- 支持 SSR ([example](https://github.com/QingWei-Li/docsify-ssr-demo)) ## 例子 @@ -28,3 +28,7 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo ## 捐赠 如果你觉得 docsify 对你有帮助，或者想对我微小的工作一点资瓷，欢迎给我[捐赠](https://github.com/QingWei-Li/donate)。 + +## Community + +Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby).