-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
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
Clean up README.md, made SETUP.md #1274
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/docsify-core/docsify-preview/8q5b9k4kd |
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 0276fb7:
|
Thanks @kirbygit For the ideas! As we chatted about,
|
Another thing is (and note I made a separate PR for CONTRIBUTING.md, but maybe we should merge into one PR) maybe we can put the contributing guide in the docs, and link to it? For example, this is how my one of my projects' My thought is then we can have all things easily in one place. Having the root |
Will make a small PR's for every change made. I agree that linking the SETUP.md inside /docs so we can show it on the site as well and people can also navigate the file from here. For that setup.md, do you think that content is perfectly fine?
Whats the best way to merge that PR to here? |
<p align="center"> | ||
<a href="https://docsify.js.org"> | ||
<img alt="docsify" src="https://github.com/docsifyjs/docsify/blob/develop/docs/_media/icon.svg"> | ||
</a> | ||
</p> | ||
|
||
<p align="center"> | ||
A magical documentation site generator. | ||
<b>Docsify</b>, a magical documentation site generator that has no statically built html files. It is simple and lightweight with a smart full-text search plugin and multiple themes, useful plugin API, compatible with IE11. It also supports both <a href="https://github.com/docsifyjs/docsify-ssr-demo">SSR</a> and embedded files. |
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.
@sy-records this is good, honestly we need more details because "magical" on the cover doesn't say much. Although I think we might become incompatible with IE11 now, and we shouldn't mention experimental and incomplete/broken SSR support.
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.
Isn't there a description of some Features below? https://docsify.js.org/#/?id=features
Summary
PREVIEW: https://github.com/kirbygit/docsify/tree/update-readme
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx]
, where "xxx" is the issue number)this is a PR for update readme, add Discord to site, other improvements/changes #1224
You have tested in the following browsers: (Providing a detailed version will be better.)