docs: add gitter

2026-03-26 10:14:32 +08:00 · 2018-06-29 22:22:14 +08:00
parent a961e3b972
commit a91d2dab67
4 changed files with 55 additions and 41 deletions
--- a/README.md
+++ b/README.md
@@ -14,6 +14,7 @@
  <a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://img.shields.io/travis/QingWei-Li/docsify/master.svg?style=flat-square"></a>
  <a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg?style=flat-square"></a>
  <a href="https://github.com/QingWei-Li/donate"><img alt="donate" src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square"></a>
+  <a href="https://gitter.im/docsifyjs/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img alt="gitter" src="https://img.shields.io/gitter/room/docsifyjs/docsify.svg?style=flat-square"></a>
 </p>

 <p align="center">Glod Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
@@ -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

--- 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).
--- 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).
--- 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).