docs: Update intro paragraph to help improve first impressions and broaden audience #2602
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
sy-records
reviewed
Sep 5, 2025
|
|
||
| ## Features | ||
|
|
||
| - No statically built html files | ||
| - No statically built HTML files |
There was a problem hiding this comment.
Should this be capitalized? If so, should /README.md also be modified?
There was a problem hiding this comment.
Yes, I think it would be best to capitalize both instances on HTML on the ReadMe - I intended to do that.
sy-records
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Update intro paragraph to improve first impressions and broaden audience for Docsify v5
Happy to further iterate/refine based on feedback!
PREVIEW👇🏼
docsify
What it is
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.htmlfile and deploy it on GitHub Pages (for more details see the Quick start guide).Related issue, if any:
What kind of change does this PR introduce?
For any code change,
Does this PR introduce a breaking change?
Tested in the following browsers: