Skip to content

Commit 21a391d

Browse files
wooormtimneutkens
wooorm
authored and
timneutkens
committed
Improve docs (mdx-js#315)
* Fix `lint-staged` for markdown * Add `changelog.md` * Improve npm search rank by having a changelog * Fix humans looking for where changes are stored * Add `code-of-conduct.md` * Update `package.json`s * Update `readme.md`s * Update core `readme.md` * Add note about financial support to `contributing.md` * Fix Tim’s email
1 parent c26a03d commit 21a391d

23 files changed

+896
-223
lines changed

‎changelog.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
See [GitHub Releases][releases] for the changelog.
4+
5+
[releases]: https://github.com/mdx-js/mdx/releases

‎code-of-conduct.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behaviour that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behaviour by participants include:
24+
25+
* The use of sexualised language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others’ private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behaviour and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behaviour.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviours that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may
53+
be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an
62+
incident. Further details of specific enforcement policies may be posted
63+
separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project’s leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at <https://www.contributor-covenant.org/version/1/4>.
73+
74+
[homepage]: https://www.contributor-covenant.org

‎contributing.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Hi! 👋
44
We’re excited that you’re interested in contributing!
55
Take a moment to read the following guidelines.
6-
And thanks for contributing to **mdx**! 👏👌✨
6+
And thanks for contributing to **MDX**! 👏👌✨
77

88
If you’re raising an issue, please understand that people involved with this
99
project often do so for fun, next to their day job; you are not entitled to
@@ -13,6 +13,7 @@ free customer service.
1313

1414
* [Questions](#questions)
1515
* [Contributions](#contributions)
16+
* [Financial support](#financial-support)
1617
* [Improve documentation](#improve-documentation)
1718
* [Improve issues](#improve-issues)
1819
* [Give feedback on issues and pull requests](#give-feedback-on-issues-and-pull-requests)
@@ -30,6 +31,16 @@ Jump in there and lurk, talk to us, and help others.
3031

3132
There’s several ways to contribute, not just by writing code.
3233

34+
### Financial support
35+
36+
It’s possible to support us financially by becoming a backer or sponsor of
37+
unified through [Open Collective][collective].
38+
With this support, we can pay for project leadership, finance non-coding work,
39+
or to do fun things for the community like getting stickers for contributors.
40+
You’ll be helping unified’s maintainers manage and improve existing projects,
41+
and additionally support our work to develop new and exciting projects, such
42+
as [micromark][].
43+
3344
### Improve documentation
3445

3546
As a user of this project you’re perfect for helping us improve our docs.
@@ -85,3 +96,7 @@ prevent you from doing unnecessary work.
8596
[unit-test]: https://twitter.com/sindresorhus/status/579306280495357953
8697

8798
[chat]: https://spectrum.chat/mdx
99+
100+
[collective]: https://opencollective.com/unified
101+
102+
[micromark]: https://github.com/micromark/micromark

‎package.json

+19-17
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
{
22
"private": true,
3-
"scripts": {
4-
"bootstrap": "lerna bootstrap && lerna link --force-local",
5-
"docs": "x0 docs",
6-
"docs:build": "x0 build docs",
7-
"docs:deploy": "npm run docs:build && now dist --public && now alias",
8-
"test": "remark . -qf && eslint . && lerna run test",
9-
"format": "remark . -qfo && eslint . --fix",
10-
"publish": "lerna publish"
11-
},
12-
"repository": "mdx-js/mdx",
133
"license": "MIT",
14-
"workspaces": [
15-
"packages/*"
16-
],
4+
"homepage": "https://mdxjs.com",
5+
"repository": "mdx-js/mdx",
6+
"bugs": "https://github.com/mdx-js/mdx/issues",
7+
"dependencies": {
8+
"@rebass/mdx": "^1.0.0-1",
9+
"styled-components": "^3.3.3"
10+
},
1711
"devDependencies": {
1812
"@compositor/x0": "^6.0.6-0",
1913
"eslint": "^5.9.0",
@@ -28,10 +22,18 @@
2822
"remark-cli": "^6.0.1",
2923
"remark-preset-wooorm": "^4.0.0"
3024
},
31-
"dependencies": {
32-
"@rebass/mdx": "^1.0.0-1",
33-
"styled-components": "^3.3.3"
25+
"scripts": {
26+
"bootstrap": "lerna bootstrap && lerna link --force-local",
27+
"docs": "x0 docs",
28+
"docs:build": "x0 build docs",
29+
"docs:deploy": "npm run docs:build && now dist --public && now alias",
30+
"test": "remark . -qf && eslint . && lerna run test",
31+
"format": "remark . -qfo && eslint . --fix",
32+
"publish": "lerna publish"
3433
},
34+
"workspaces": [
35+
"packages/*"
36+
],
3537
"prettier": {
3638
"tabWidth": 2,
3739
"useTabs": false,
@@ -69,7 +71,7 @@
6971
"git add"
7072
],
7173
"*.md": [
72-
"remark -qfo",
74+
"remark -qf",
7375
"git add"
7476
]
7577
},

‎packages/create-mdx/package.json

+23-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,33 @@
11
{
22
"name": "create-mdx",
3-
"description": "Initialize an MDX project",
43
"version": "0.16.0",
4+
"description": "Initialize an MDX project",
55
"license": "MIT",
6-
"author": "John Otander",
6+
"keywords": [
7+
"create",
8+
"mdx",
9+
"app",
10+
"markdown",
11+
"react",
12+
"jsx",
13+
"remark",
14+
"unified"
15+
],
16+
"homepage": "https://mdxjs.com",
17+
"repository": "mdx-js/mdx",
18+
"bugs": "https://github.com/mdx-js/mdx/issues",
19+
"author": "John Otander <[email protected]> (http://johnotander.com)",
20+
"contributors": [
21+
"John Otander <[email protected]> (http://johnotander.com)",
22+
"Tim Neutkens <[email protected]>",
23+
"Matija Marohnić <[email protected]>",
24+
"Titus Wormer <[email protected]> (https://wooorm.com)"
25+
],
726
"bin": {
827
"create-mdx": "cli.js"
928
},
10-
"keywords": [
11-
"mdx"
29+
"files": [
30+
"cli.js"
1231
],
1332
"dependencies": {
1433
"initit": "^1.0.0-2"

‎packages/create-mdx/readme.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# create-mdx
2+
3+
[![Build Status][build-badge]][build]
4+
[![lerna][lerna-badge]][lerna]
5+
[![Join the community on Spectrum][spectrum-badge]][spectrum]
6+
7+
Create an [MDX][] project.
8+
9+
## Usage
10+
11+
Use it directly with [`npm init`][npm]:
12+
13+
```sh
14+
npm init mdx gatsby "my-new-project"
15+
```
16+
17+
## API
18+
19+
### `npm init mdx [type=next] [name=next-mdx]`
20+
21+
Create a new [MDX][] project.
22+
Defaults to the [Next][] example, but `type` can also be `create-react-app`,
23+
`parcel`, `razzle`, or `x0`.
24+
Name can be any name but defaults to `next-mdx`.
25+
26+
## Contribute
27+
28+
See [`contributing.md` in `mdx-js/mdx`][contributing] for ways to get started.
29+
30+
This organisation has a [Code of Conduct][coc].
31+
By interacting with this repository, organisation, or community you agree to
32+
abide by its terms.
33+
34+
## License
35+
36+
[MIT][] © [Compositor][] and [ZEIT][]
37+
38+
<!-- Definitions -->
39+
40+
[build]: https://travis-ci.org/mdx-js/mdx
41+
42+
[build-badge]: https://travis-ci.org/mdx-js/mdx.svg?branch=master
43+
44+
[lerna]: https://lernajs.io/
45+
46+
[lerna-badge]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
47+
48+
[spectrum]: https://spectrum.chat/mdx
49+
50+
[spectrum-badge]: https://withspectrum.github.io/badge/badge.svg
51+
52+
[contributing]: https://github.com/mdx-js/mdx/blob/master/contributing.md
53+
54+
[coc]: https://github.com/mdx-js/mdx/blob/master/code-of-conduct.md
55+
56+
[mit]: https://github.com/mdx-js/mdx/blob/master/license
57+
58+
[compositor]: https://compositor.io
59+
60+
[zeit]: https://zeit.co
61+
62+
[mdx]: https://github.com/mdx-js/mdx
63+
64+
[npm]: https://docs.npmjs.com/cli/init
65+
66+
[next]: https://github.com/mdx-js/mdx/tree/master/examples/next

‎packages/loader/package.json

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
11
{
22
"name": "@mdx-js/loader",
33
"version": "0.16.0",
4-
"license": "MIT",
5-
"repository": "mdx-js/mdx",
64
"description": "Loader for MDX",
7-
"files": [
8-
"index.js"
9-
],
10-
"scripts": {
11-
"test": "jest"
12-
},
5+
"license": "MIT",
136
"keywords": [
14-
"react",
7+
"mdx",
158
"markdown",
9+
"react",
10+
"jsx",
1611
"remark",
1712
"styleguide",
1813
"webpack",
1914
"loader"
2015
],
16+
"homepage": "https://mdxjs.com",
17+
"repository": "mdx-js/mdx",
18+
"bugs": "https://github.com/mdx-js/mdx/issues",
19+
"author": "John Otander <[email protected]> (http://johnotander.com)",
20+
"contributors": [
21+
"John Otander <[email protected]> (http://johnotander.com)",
22+
"Tim Neutkens <[email protected]>",
23+
"Matija Marohnić <[email protected]>",
24+
"Titus Wormer <[email protected]> (https://wooorm.com)"
25+
],
26+
"files": [
27+
"index.js"
28+
],
2129
"dependencies": {
2230
"@mdx-js/mdx": "^0.16.0",
2331
"@mdx-js/tag": "^0.16.0",
@@ -33,6 +41,9 @@
3341
"react": "^16.3.2",
3442
"webpack": "^4.5.0"
3543
},
44+
"scripts": {
45+
"test": "jest"
46+
},
3647
"jest": {
3748
"testEnvironment": "node"
3849
}

0 commit comments

Comments
 (0)