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..df034c1bb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +
- 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.
+ -Gold Sponsor via Open Collective
- +
-
-
-
+
+
+
+
+
+Be a backer for our awesome project by clicking this link. Thank you to all our backers! ๐
+
+
+
+
+ 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. - -[](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)] - -