You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -18,7 +17,8 @@ This module is distributed via [npm](https://www.npmjs.com/) which is bundled wi
18
17
should be installed as one of your project's `devDependencies`:
19
18
20
19
```console
21
-
yarn add --dev all-contributors-cli # or npm i -D all-contributors-cli
20
+
npm i -D all-contributors-cli
21
+
# If you are a yarn user: yarn add --dev all-contributors-cli
22
22
```
23
23
24
24
Alternatively, Arch Linux users can install the [`all-contributors-cli`](https://aur.archlinux.org/packages/all-contributors-cli) package from the AUR.
@@ -30,7 +30,8 @@ Alternatively, Arch Linux users can install the [`all-contributors-cli`](https:/
30
30
Init the project using `init` and answer a few questions
31
31
32
32
```console
33
-
yarn all-contributors init # or npx all-contributors init
Copy file name to clipboardExpand all lines: docs/cli/usage.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebar_label: Usage
6
6
7
7
> This usage documentation assumes you have already followed the [cli installation steps](installation).
8
8
9
-
A quick note: Below we'll just show `all-contributors` to keep things simple, but if you're having any difficulties, then give the `yarn all-contributors` route a try 😺
9
+
A quick note: Below we'll just show `all-contributors` to keep things simple, but if you're having any difficulties, then give the `npx all-contributors-cli init` route a try 😺.
Copy file name to clipboardExpand all lines: docs/emoji-key.md
+29-29Lines changed: 29 additions & 29 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,41 +8,41 @@ sidebar_label: Emoji Key ✨
8
8
9
9
> To have a contribution added when using the [Bot](bot/overview) or [CLI](cli/overview) use the keyword in the `Type` column. The bot will also use [basic Natural Language Parsing](https://github.com/all-contributors/app/blob/master/lib/parse-comment.js) to determine your contribution intent.
10
10
11
-
Emoji/Type | Represents | Comments
12
-
:---: | :---: | :---:
13
-
🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects
14
-
♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues
15
-
🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project
16
-
📝 <br /> `blog` | Blogposts | Links to the blogpost
17
-
💼 <br /> `business` | Business Development | People who execute on the business end
18
-
💻 <br /> `code` | Code | Links to commits by the user on this project
19
-
🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate
20
-
🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets)
21
-
📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation
22
-
🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc.
23
-
💡 <br /> `example` | Examples | Links to the examples
11
+
Emoji/Type | Represents | Comments |
12
+
:---: | :---: | :---: |
13
+
🔊 <br /> `audio` | Audio | Podcasts, background music or sound effects |
14
+
♿️ <br /> `a11y` | Accessibility | Reporting or working on accessibility issues |
15
+
🐛 <br /> `bug` | Bug reports | Links to issues reported by the user on this project |
16
+
📝 <br /> `blog` | Blogposts | Links to the blogpost |
17
+
💼 <br /> `business` | Business Development | People who execute on the business end |
18
+
💻 <br /> `code` | Code | Links to commits by the user on this project |
19
+
🖋 <br /> `content` | Content | e.g. website copy, blog posts are separate |
20
+
🔣 <br /> `data` | Data | Links to contributed data for the project (both tests and datasets) |
21
+
📖 <br /> `doc` | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation |
22
+
🎨 <br /> `design` | Design | Links to the logo/iconography/visual design/etc. |
23
+
💡 <br /> `example` | Examples | Links to the examples |
Copy file name to clipboardExpand all lines: docs/project/contribute.md
+41-5Lines changed: 41 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,13 +64,49 @@ Search is by algolia, the configuration is at <https://github.com/algolia/docsea
64
64
65
65
## Running the site locally:
66
66
67
-
All Contributors uses Docusaurus to maintain our documentation website. For more info visit the [Docusaurus Website](https://docusaurus.io)
67
+
All Contributors currently uses [Docusaurus 1.x](https://docusaurus.io) for our documentation website.
68
68
69
-
To get started locally:
69
+
To build the docs locally:
70
70
71
-
-`yarn install`
72
-
-`yarn start`
73
-
- go to `http://localhost:3000` (Refresh the page for your changes to be reflected)
71
+
Make sure `npm` is installed on your machine. Use the [nodejs documentation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you aren't sure how to install `npm`.
72
+
To check that npm is installed run the following in your favorite shell:
73
+
74
+
`npm -v`
75
+
76
+
Next, make sure you have at least node version 0.22 (LTS) or higher. To check the version,
77
+
use:
78
+
79
+
`node -v`
80
+
81
+
If you don't have at least version `0.22` or higher, please install Node or upgrade your current version.
82
+
83
+
Install docusaurus v1 (1.14.7) and all of the project dependencies using `npm install`. *Note: This project does not yet support docusaurus v2 or v3; though, we hope to do so in the future.*
84
+
85
+
`npm install`
86
+
87
+
Once you have completed the above, you can launch a server locally that will build and run the docs locally. In your favorite shell run:
88
+
89
+
`npm run start`
90
+
91
+
* Then, go to `http://localhost:3000` and you will see the all contributors website there!
92
+
* Refresh the browser page as needed when editing markdown pages.
93
+
94
+
### Make changes - linting your contribution
95
+
96
+
If you make changes to a markdown file in the site, then our linting action will
97
+
check those changes. To run the linter yourself on a file locally:
98
+
99
+
First install markdownlint-cli:
100
+
101
+
`npm install -g markdownlint-cli`
102
+
103
+
Then run markdownlint on the file (or files) that you wish to check:
104
+
105
+
`markdownlint --fix "docs/project/contribute.md"`
106
+
107
+
Or you can run it on all files in the docs directory, like this:
**Note**: There are many projects not listed here. You'll probably be able to find more with this
50
-
[github search for .all-contributorsrc](https://github.com/search?utf8=%E2%9C%93&q=.all-contributorsrc+in%3Apath&type=Code&ref=searchresults)
51
+
[github search for .all-contributorsrc](https://github.com/search?utf8=%E2%9C%93&q=path%3A.all-contributorsrc&type=code&ref=searchresults)
0 commit comments