test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-30 02:58:37 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

chore: README: various small tweaks (#651)

Browse Source 
- Change "What is it" heading to "What it is", as it's not a question
- Expand SSR acronym
- Slightly reword some passages for clarity
This commit is contained in:
Waldir Pimenta 2018-10-23 08:01:55 +01:00 committed by cinwell.li
parent 18f0f03a89
commit 47a8d5faa4
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@ -2,11 +2,11 @@
> A magical documentation site generator.
## What is it
## What it is
docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](deploy.md).
docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
See the [Quick start](quickstart.md) for more details.
See the [Quick start](quickstart.md) guide for more details.
## Features
@ -17,11 +17,11 @@ See the [Quick start](quickstart.md) for more details.
- Useful plugin API
- Emoji support
- Compatible with IE10+
- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
## Examples
Check out the [Showcase](https://github.com/docsifyjs/docsify/#showcase) to docsify in use.
Check out the [Showcase](https://github.com/docsifyjs/docsify/#showcase) to see docsify in use.
## Donate
@ -29,4 +29,4 @@ Please consider donating if you think docsify is helpful to you or that my work
## Community
Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby).
Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).