Skip to content

Commit a1d4a39

Browse files
kirbyfernkirbyfern
committed
Clean up README, update CONTRIBUTING, added SETUP.md
1 parent a714dae commit a1d4a39

File tree

3 files changed

+93
-106
lines changed

3 files changed

+93
-106
lines changed

‎CONTRIBUTING.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
# Contribute
1+
# Guide To Contribution
22

33
## Introduction
44

55
First, thank you for considering contributing to docsify! It's people like you that make the open source community such a great community! 😊
66

7-
We welcome any type of contribution, not only code. You can help with
7+
We welcome any type of contribution, not only code. You can help with
88
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
99
- **Marketing**: writing blog posts, howto's, printing stickers, ...
1010
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
1111
- **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.
1212
- **Money**: we welcome financial contributions in full transparency on our [open collective](https://opencollective.com/docsify).
1313

14+
## Quick Setup
15+
16+
You can visit this quick [guide on setting up your docsify project locally](https://github.com/docsifyjs/docsify/blob/develop/SETUP.md).
17+
18+
1419
## Your First Contribution
1520

1621
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).

‎README.md

Lines changed: 61 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1+
<!---
2+
Logo
3+
-->
14
<p align="center">
25
<a href="https://docsify.js.org">
36
<img alt="docsify" src="https://github.com/docsifyjs/docsify/blob/develop/docs/_media/icon.svg">
47
</a>
58
</p>
69

710
<p align="center">
8-
A magical documentation site generator.
11+
<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.
912
</p>
1013

14+
<!---
15+
Badges
16+
-->
1117
<p align="center">
1218
<a href="https://discord.gg/3NwKFyR"><img
1319
alt="Join Discord community and chat about Docsify"
@@ -36,123 +42,74 @@
3642
/></a>
3743
</p>
3844

39-
<p align="center">Gold Sponsor via <a href="https://opencollective.com/docsify">Open Collective</a></p>
40-
45+
<!---
46+
About, Intro, Contributing
47+
-->
4148
<p align="center">
42-
<a href="https://opencollective.com/docsify/order/3254">
43-
<img src="https://opencollective.com/docsify/tiers/gold-sponsor.svg?avatarHeight=36">
44-
</a>
49+
<h3 align="center">
50+
<a href="https://docsify.js.org/#/quickstart">Quick start</a> &nbsp;·&nbsp;
51+
<a href="https://github.com/docsifyjs/docsify/blob/develop/CONTRIBUTING.md">Introduction</a> &nbsp;·&nbsp;
52+
<a href="https://github.com/docsifyjs/docsify/blob/develop/SETUP.md">Contributing</a> &nbsp;·&nbsp;
53+
<a href="https://github.com/docsifyjs/docsify-cli">CLI</a> &nbsp;·&nbsp;
54+
<a href="https://docsify.js.org/#/deploy">Development Instructions</a> &nbsp;&nbsp;
55+
</h3>
4556
</p>
4657

47-
## Links
48-
49-
- [`develop` branch preview](https://docsifyjs.netlify.com/)
50-
- [Documentation](https://docsify.js.org)
51-
- [CLI](https://github.com/docsifyjs/docsify-cli)
52-
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
53-
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
54-
- [Community chat](https://discord.gg/3NwKFyR)
55-
56-
## Features
57-
58-
- No statically built html files
59-
- Simple and lightweight (~21kB gzipped)
60-
- Smart full-text search plugin
61-
- Multiple themes
62-
- Useful plugin API
63-
- Compatible with IE11
64-
- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
65-
- Support embedded files
58+
<!---
59+
Contributors
60+
-->
6661

67-
## Quick start
62+
<h2 align="center">Contributors</h2>
6863

69-
Look at [this tutorial](https://docsify.js.org/#/quickstart)
64+
<p align="center">
65+
<a href="https://github.com/docsifyjs/docsify/graphs/contributors">
66+
<img src="https://opencollective.com/docsify/contributors.svg?width=890" />
67+
</a>
68+
</p>
7069

71-
[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
70+
<!---
71+
Backers
72+
-->
73+
<h2 align="center">Much love to all our backers</h2>
74+
<p align="center">
75+
Be a backer for our awesome project by clicking this <a href="https://opencollective.com/docsify#backers" target="_blank" rel="noopener">link</a>. Thank you to all our backers! 🙏
76+
<a href="https://opencollective.com/docsify#backers" target="_blank">
77+
<img src="https://opencollective.com/docsify/backers.svg?width=890">
78+
</a>
79+
</p>
7280

73-
## Showcase
81+
<!---
82+
Sponsors
83+
-->
84+
<h2 align="center"> Much love to all our sponsors! </h2>
7485

75-
These projects are using docsify to generate their sites. Pull requests welcome :blush:
86+
<p align="justify">
87+
Support this project by donating to our <a href="https://opencollective.com/docsify#silver-sponsors" target="_blank" rel="noopener">OpenCollective</a>. 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!
88+
</p>
7689

77-
Move to [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase)
90+
<p align="center">
91+
<a href="https://opencollective.com/docsify/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/0/avatar.svg"></a>
92+
<a href="https://opencollective.com/docsify/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/1/avatar.svg"></a>
93+
<a href="https://opencollective.com/docsify/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/2/avatar.svg"></a>
94+
<a href="https://opencollective.com/docsify/silver-sponsors/3/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/3/avatar.svg"></a>
95+
<a href="https://opencollective.com/docsify/silver-sponsors/4/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/4/avatar.svg"></a>
96+
<a href="https://opencollective.com/docsify/silver-sponsors/5/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/5/avatar.svg"></a>
97+
<a href="https://opencollective.com/docsify/silver-sponsors/6/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/6/avatar.svg"></a>
98+
<a href="https://opencollective.com/docsify/silver-sponsors/7/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/7/avatar.svg"></a>
99+
<a href="https://opencollective.com/docsify/silver-sponsors/8/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/8/avatar.svg"></a>
100+
</p>
78101

79-
## Similar projects
102+
### Showcase
80103

81-
| Project | Description |
104+
| Links | Description |
82105
| ------------------------------------------------ | ---------------------------------------- |
106+
| [Awesome Docsify](https://github.com/docsifyjs/awesome-docsify) | Awesome things related to [docsify](https://docsify.js.org/). |
83107
| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
84108
| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
85-
86-
## Contributing
87-
88-
### Online one-click setup for Contributing
89-
90-
You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:
91-
92-
- clone the docsify repo.
93-
- install the dependencies.
94-
- start `npm run dev`.
95-
96-
So that you can start straight away.
97-
98-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)
99-
100-
- Fork it!
101-
- Create your feature branch: `git checkout -b my-new-feature`
102-
- Commit your changes: `git commit -am 'Add some feature'`
103-
- Push to the branch: `git push origin my-new-feature`
104-
- Submit a pull request
105-
106-
## Development
107-
108-
```bash
109-
npm run bootstrap && npm run dev
110-
```
111-
112-
## Backers
113-
114-
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify#backers)]
115-
116-
<a href="https://opencollective.com/docsify#backers" target="_blank"><img src="https://opencollective.com/docsify/backers.svg?width=890"></a>
117-
118-
## Sponsors
119-
120-
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)]
121-
122-
<a href="https://opencollective.com/docsify/silver-sponsors/0/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/0/avatar.svg"></a>
123-
<a href="https://opencollective.com/docsify/silver-sponsors/1/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/1/avatar.svg"></a>
124-
<a href="https://opencollective.com/docsify/silver-sponsors/2/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/2/avatar.svg"></a>
125-
<a href="https://opencollective.com/docsify/silver-sponsors/3/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/3/avatar.svg"></a>
126-
<a href="https://opencollective.com/docsify/silver-sponsors/4/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/4/avatar.svg"></a>
127-
<a href="https://opencollective.com/docsify/silver-sponsors/5/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/5/avatar.svg"></a>
128-
<a href="https://opencollective.com/docsify/silver-sponsors/6/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/6/avatar.svg"></a>
129-
<a href="https://opencollective.com/docsify/silver-sponsors/7/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/7/avatar.svg"></a>
130-
<a href="https://opencollective.com/docsify/silver-sponsors/8/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/8/avatar.svg"></a>
131-
<a href="https://opencollective.com/docsify/silver-sponsors/9/website" target="_blank"><img src="https://opencollective.com/docsify/silver-sponsors/9/avatar.svg"></a>
132-
133-
## Contributors
134-
135-
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
136-
<a href="https://github.com/docsifyjs/docsify/graphs/contributors"><img src="https://opencollective.com/docsify/contributors.svg?width=890" /></a>
137-
138-
## Status
139-
140-
<a href="https://github.com/docsifyjs/docsify/actions?query=workflow%3A%22unit+tests%22"><img
141-
alt="Docsify unit test suite"
142-
title="Docsify unit test suite"
143-
src="https://img.shields.io/github/workflow/status/docsifyjs/docsify/unit tests/develop?label=unit%20tests&cacheSeconds=300"
144-
/></a>
145-
<a href="https://github.com/docsifyjs/docsify/actions?query=workflow%3A%22e2e+tests%22"><img
146-
alt="Docsify e2e test suites"
147-
title="Docsify e2e test suites"
148-
src="https://img.shields.io/github/workflow/status/docsifyjs/docsify/e2e tests/develop?label=e2e%20tests&cacheSeconds=300"
149-
/></a>
150-
<a href="https://github.com/docsifyjs/docsify/actions?query=workflow%3A%22lint+checks%22"><img
151-
alt="Docsify linting checks"
152-
title="Docsify linting checks"
153-
src="https://img.shields.io/github/workflow/status/docsifyjs/docsify/lint checks/develop?label=lint%20checks&cacheSeconds=300"
154-
/></a>
109+
| [unpkg](https://unpkg.com/browse/[email protected]/) | CDN |
110+
| [jsdelivr](https://cdn.jsdelivr.net/npm/docsify/) | CDN |
111+
| [cdnjs](https://cdnjs.com/libraries/docsify) | CDN |
155112

156113
## License
157114

158-
[MIT](LICENSE)
115+
[MIT](LICENSE)

‎SETUP.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
### Quick guide for Contributing and Setup
2+
3+
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:
4+
5+
- clone the docsify repo.
6+
- install the dependencies.
7+
- start `npm run dev`.
8+
9+
So that you can start straight away.
10+
11+
[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)
12+
13+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/docsifyjs/docsify)
14+
15+
- Fork it!
16+
- Create your feature branch: `git checkout -b my-new-feature`
17+
- Commit your changes: `git commit -am 'Add some feature'`
18+
- Push to the branch: `git push origin my-new-feature`
19+
- Submit a pull request
20+
21+
## Development
22+
23+
```bash
24+
npm run bootstrap && npm run dev
25+
```

0 commit comments

Comments
 (0)