From 8fe0e1c0f1641c323e1a5a360cb9a5dc0fc4195a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Paul=20Hibbitts=20=F0=9F=8D=81?= Date: Sat, 27 Sep 2025 19:43:05 -0700 Subject: [PATCH] docs: Update intro paragraph to help improve first impressions and broaden audience (#2602) Co-authored-by: Luffy --- README.md | 2 +- docs/README.md | 6 ++---- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 31d759d34e..192a8c00f4 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Docsify turns one or more Markdown files into a Website, with no build process r ## Features -- No statically built html files +- No statically built HTML files - Simple and lightweight - Smart full-text search plugin - Multiple themes diff --git a/docs/README.md b/docs/README.md index 1486fa48b0..48fb465889 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,13 +4,11 @@ ## 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). - -See the [Quick start](quickstart.md) guide for more details. +Docsify turns your Markdown files into a documentation website instantly. Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an `index.html` file and [deploy it on GitHub Pages](deploy.md) (for more details see the [Quick start](quickstart.md) guide). ## Features -- No statically built html files +- No statically built HTML files - Simple and lightweight - Smart full-text search plugin - Multiple themes