From 18cd18ce045f0567370d43e9ec47c63abe5bf1b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B2=88=E5=94=81?= <52o@qq52o.cn> Date: Wed, 2 Feb 2022 17:50:20 +0800 Subject: [PATCH] docs: update readme (#1740) --- README.md | 4 +--- docs/README.md | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b5c803dc0..b0597a40d 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,7 @@ Backers on Open Collective Sponsors on Open Collective - Unit tests Suite - Linting Checks - Testing the e2e test suites + Build & Test npm donate Join Discord community and chat about Docsify diff --git a/docs/README.md b/docs/README.md index ca396b7b8..64f927f40 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## 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 a website. To start using it, all you need to do is create an `index.html` 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) guide for more details.