-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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.
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
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
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: