From a1d4a392431ffd14dc751691e4e9ba319f060940 Mon Sep 17 00:00:00 2001 From: kirbygit Date: Mon, 6 Jul 2020 13:05:39 -0700 Subject: [PATCH 1/2] Clean up README, update CONTRIBUTING, added SETUP.md --- CONTRIBUTING.md | 9 ++- README.md | 165 ++++++++++++++++++------------------------------ SETUP.md | 25 ++++++++ 3 files changed, 93 insertions(+), 106 deletions(-) create mode 100644 SETUP.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77d2ce780..057f56ae8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,16 +1,21 @@ -# Contribute +# Guide To Contribution ## Introduction First, thank you for considering contributing to docsify! It's people like you that make the open source community such a great community! ๐Ÿ˜Š -We welcome any type of contribution, not only code. You can help with +We welcome any type of contribution, not only code. You can help with - **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open) - **Marketing**: writing blog posts, howto's, printing stickers, ... - **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ... - **Code**: take a look at the [open issues](issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them. - **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/docsify). +## Quick Setup + +You can visit this quick [guide on setting up your docsify project locally](https://github.com/docsifyjs/docsify/blob/develop/SETUP.md). + + ## Your First Contribution Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github). diff --git a/README.md b/README.md index e33a35bbe..10b3a60fc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +

docsify @@ -5,9 +8,12 @@

- A magical documentation site generator. + Docsify, 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 SSR and embedded files.

+

Join Discord community and chat about Docsify

-

Gold Sponsor via Open Collective

- +

- - - +

+ Quick start  ยท  + Introduction  ยท  + Contributing  ยท  + CLI  ยท  + Development Instructions    +

-## Links - -- [`develop` branch preview](https://docsifyjs.netlify.com/) -- [Documentation](https://docsify.js.org) -- [CLI](https://github.com/docsifyjs/docsify-cli) -- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) -- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify) -- [Community chat](https://discord.gg/3NwKFyR) - -## Features - -- No statically built html files -- Simple and lightweight (~21kB gzipped) -- Smart full-text search plugin -- Multiple themes -- Useful plugin API -- Compatible with IE11 -- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo)) -- Support embedded files + -## Quick start +

Contributors

-Look at [this tutorial](https://docsify.js.org/#/quickstart) +

+ + + +

-[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) + +

Much love to all our backers

+

+Be a backer for our awesome project by clicking this link. Thank you to all our backers! ๐Ÿ™ + + + +

-## Showcase + +

Much love to all our sponsors!

-These projects are using docsify to generate their sites. Pull requests welcome :blush: +

+ Support this project by donating to our OpenCollective. By sponsoring this project your logo will be shown below. The core maintainers and contributors to this open-source project are working mostly in their free time.. Thank you so much for your never ending support! +

-Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase) +

+ + + + + + + + + +

-## Similar projects +### Showcase -| Project | Description | +| Links | Description | | ------------------------------------------------ | ---------------------------------------- | +| [Awesome Docsify](https://github.com/docsifyjs/awesome-docsify) | Awesome things related to [docsify](https://docsify.js.org/). | | [docute](https://github.com/egoist/docute) | ๐Ÿ“œ Effortlessly documentation done right | | [docpress](https://github.com/docpress/docpress) | Documentation website generator | - -## Contributing - -### Online one-click setup for Contributing - -You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically: - -- clone the docsify repo. -- install the dependencies. -- start `npm run dev`. - -So that you can start straight away. - -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify) - -- Fork it! -- Create your feature branch: `git checkout -b my-new-feature` -- Commit your changes: `git commit -am 'Add some feature'` -- Push to the branch: `git push origin my-new-feature` -- Submit a pull request - -## Development - -```bash -npm run bootstrap && npm run dev -``` - -## Backers - -Thank you to all our backers! ๐Ÿ™ [[Become a backer](https://opencollective.com/docsify#backers)] - - - -## Sponsors - -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)] - - - - - - - - - - - - -## Contributors - -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - - -## Status - -Docsify unit test suite -Docsify e2e test suites -Docsify linting checks +| [unpkg](https://unpkg.com/browse/docsify@4.11.4/) | CDN | +| [jsdelivr](https://cdn.jsdelivr.net/npm/docsify/) | CDN | +| [cdnjs](https://cdnjs.com/libraries/docsify) | CDN | ## License -[MIT](LICENSE) +[MIT](LICENSE) \ No newline at end of file diff --git a/SETUP.md b/SETUP.md new file mode 100644 index 000000000..81fd2782e --- /dev/null +++ b/SETUP.md @@ -0,0 +1,25 @@ +### Quick guide for Contributing and Setup + +You can use Gitpod(A free online VS Code-like IDE) or CodeSandBox for contributing. With single click it'll launch a workspace and automatically: + +- clone the docsify repo. +- install the dependencies. +- start `npm run dev`. + +So that you can start straight away. + +[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify) + +- Fork it! +- Create your feature branch: `git checkout -b my-new-feature` +- Commit your changes: `git commit -am 'Add some feature'` +- Push to the branch: `git push origin my-new-feature` +- Submit a pull request + +## Development + +```bash +npm run bootstrap && npm run dev +``` \ No newline at end of file From 0276fb76652cb8ba8abf53b4d0de38cb5b6e0720 Mon Sep 17 00:00:00 2001 From: kirbygit Date: Mon, 6 Jul 2020 13:14:23 -0700 Subject: [PATCH 2/2] Fix typo error on readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 10b3a60fc..df034c1bb 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Sponsors

Much love to all our sponsors!

- Support this project by donating to our OpenCollective. By sponsoring this project your logo will be shown below. The core maintainers and contributors to this open-source project are working mostly in their free time.. Thank you so much for your never ending support! + Support this project by donating to our OpenCollective. By sponsoring this project your logo will be shown below. The core maintainers and contributors to this open-source project are working mostly in their free time. Thank you so much for your never ending support!