Skip to content

docs: Update intro paragraph to help improve first impressions and broaden audience #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

paulhibbitts wants to merge 10 commits into docsifyjs:develop

from paulhibbitts:develop

Open

docs: Update intro paragraph to help improve first impressions and broaden audience #2602

Changes from all commits

Commits

Show all changes

Select commit Hold shift + click to select a range

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

Update README.md

paulhibbitts Sep 5, 2025

File filter

Filter by extension

Conversations

Jump to

Jump to file

Failed to load files.

Loading

Diff view

Diff view

6 changes: 2 additions & 4 deletions docs/README.md

Show comments View file Open in desktop

Original file line number	Diff line number	Diff line change
Expand Up		@@ -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
Copy link Member @sy-records sy-records Sep 5, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Should this be capitalized? If so, should /README.md also be modified? Copy link Collaborator Author @paulhibbitts paulhibbitts Sep 6, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Yes, I think it would be best to capitalize both instances on HTML on the ReadMe - I intended to do that. sy-records reacted with thumbs up emoji
		- Simple and lightweight
		- Smart full-text search plugin
		- Multiple themes
Expand Down

Loading