Skip to content

Commit 47a8d5f

Browse files
waldyriousQingWei-Li
authored andcommitted
chore: README: various small tweaks (#651)
- Change "What is it" heading to "What it is", as it's not a question - Expand SSR acronym - Slightly reword some passages for clarity
1 parent 18f0f03 commit 47a8d5f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
> A magical documentation site generator.
44
5-
## What is it
5+
## What it is
66

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

9-
See the [Quick start](quickstart.md) for more details.
9+
See the [Quick start](quickstart.md) guide for more details.
1010

1111
## Features
1212

@@ -17,16 +17,16 @@ See the [Quick start](quickstart.md) for more details.
1717
- Useful plugin API
1818
- Emoji support
1919
- Compatible with IE10+
20-
- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
20+
- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
2121

2222
## Examples
2323

24-
Check out the [Showcase](https://github.com/docsifyjs/docsify/#showcase) to docsify in use.
24+
Check out the [Showcase](https://github.com/docsifyjs/docsify/#showcase) to see docsify in use.
2525

2626
## Donate
2727

2828
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:
2929

3030
## Community
3131

32-
Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby).
32+
Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).

0 commit comments

Comments
 (0)