Skip to content

Commit 8fe0e1c

Browse files
docs: Update intro paragraph to help improve first impressions and broaden audience (#2602)
Co-authored-by: Luffy <[email protected]>
1 parent 422a745 commit 8fe0e1c

File tree

2 files changed

+3
-5
lines changed

2 files changed

+3
-5
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Docsify turns one or more Markdown files into a Website, with no build process r
3030

3131
## Features
3232

33-
- No statically built html files
33+
- No statically built HTML files
3434
- Simple and lightweight
3535
- Smart full-text search plugin
3636
- Multiple themes

docs/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,11 @@
44
55
## 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 a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
8-
9-
See the [Quick start](quickstart.md) guide for more details.
7+
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).
108

119
## Features
1210

13-
- No statically built html files
11+
- No statically built HTML files
1412
- Simple and lightweight
1513
- Smart full-text search plugin
1614
- Multiple themes

0 commit comments

Comments
 (0)