From 47a8d5faa4d7394a2ac6d119578870ec578cdc69 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Tue, 23 Oct 2018 08:01:55 +0100 Subject: [PATCH] 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 --- docs/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 3a7721d97..ee2385a6b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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).