Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨V1 #451

Merged
merged 55 commits into from
Apr 4, 2019
Merged

✨V1 #451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
c68db51
Replace MDXTag with custom pragma (#401)
ChristopherBiscardi Feb 26, 2019
c433fc7
Allow for merging of components passed to context with a function (#411)
johno Feb 27, 2019
07e3a72
feat: Convert withMDXComponents to use hooks (#417)
alexandernanberg Feb 28, 2019
0fb529e
Update tests after rebase
johno Mar 6, 2019
c241279
Use remark-mdx in core as a syntactic extension to remark (#439)
johno Mar 6, 2019
36c1a20
Add next publish script
johno Mar 6, 2019
83228c3
v1.0.0-alpha.0
johno Mar 6, 2019
bf0bb8c
Add useMDXComponents hook (#440)
alexandernanberg Mar 6, 2019
f001fdc
Automatically merge outer context for components in the provider (#441)
johno Mar 6, 2019
8c027ad
Convert MDXContent to a function component (#427)
alexandernanberg Mar 6, 2019
6a2677c
Fix rebase
johno Mar 6, 2019
ace6f04
Add more involved usage docs
johno Mar 6, 2019
5f94f32
Add nav for api doc
johno Mar 6, 2019
09713d4
Move API docs to main advanced page
johno Mar 6, 2019
ef167bf
v1.0.0-alpha.1
johno Mar 6, 2019
328db2d
Fix inline comments (#456)
wooorm Mar 8, 2019
1ff9994
Merge branch 'master' into v1
johno Mar 11, 2019
11cbf63
[WIP] Implement basic Vue support (#455)
johno Mar 11, 2019
33cc98c
Ignore imports used in exports when parsing (#461)
johno Mar 11, 2019
126e0b7
v1.0.0-alpha.6
johno Mar 11, 2019
2751ced
Update docs/advanced/index.md
ticky Mar 11, 2019
490f700
Use mdxType as prop name (#462)
johno Mar 12, 2019
93aeb8d
v1.0.0-alpha.7
johno Mar 13, 2019
a94509a
Mdx wrapper guide (#467)
johno Mar 13, 2019
75d7dab
Rename mdPlugins/hastPlugins to remarkPlugins/rehypePlugins (#468)
johno Mar 13, 2019
b44aa5d
Remove trailing space from prop-less JSX tags (#477)
pshrmn Mar 20, 2019
410d43c
wrapper replacement (#479)
ChristopherBiscardi Mar 21, 2019
cbc8c8a
Fix remark-mdx readme title (#481)
leonardodino Mar 21, 2019
a96f0fd
v1.0.0-alpha.8
johno Mar 21, 2019
9ee5460
Change wrapper default element to React.Fragment (#470)
alexandernanberg Mar 21, 2019
aca9261
v1.0.0-alpha.9
johno Mar 21, 2019
a3f68d6
Raw nodes should always be of type jsx (#484)
johno Mar 27, 2019
ab48d0a
pass filename to babel transform if present (#485)
jescalan Mar 27, 2019
bc4a339
Fix test suite
johno Mar 27, 2019
1365421
v1.0.0-alpha.10
johno Mar 27, 2019
870a1d0
Add wrapExport option for wrapping exported fn (#475)
pshrmn Mar 28, 2019
0e36efe
v1.0.0-alpha.11
johno Mar 28, 2019
04a1323
Merge branch 'master' into v1
johno Mar 28, 2019
a5eb374
Pull in proper remark-mdx version
johno Mar 28, 2019
1be8ae3
Rename tag package to react, move create-element to new package (#487)
johno Mar 28, 2019
eca1474
Update docs for new react package name (#490)
johno Mar 28, 2019
7bdcf91
v1.0.0-alpha.12
johno Mar 28, 2019
0fa7625
v1.0.0-alpha.13
johno Mar 28, 2019
033bcc9
Add remove exports plugin (#488)
johno Mar 28, 2019
3ac5736
v1.0.0-alpha.14
johno Mar 28, 2019
ed8845e
Fix missing loader dep (#491)
johno Mar 28, 2019
a4265e9
v1.0.0-alpha.15
johno Mar 28, 2019
88f2f06
Fix missing 'create-element' file (#493)
alexandernanberg Mar 29, 2019
0cca711
v1.0.0-alpha.16
johno Mar 29, 2019
b1c783c
Export mdx from main @mdx-js/react module (#495)
pshrmn Mar 30, 2019
690cd8d
v1.0.0-alpha.17
johno Mar 30, 2019
cf74611
Move to babel v7 (#494)
alexandernanberg Apr 3, 2019
79cff1d
V1 docs update (#498)
jxnblk Apr 4, 2019
ae97154
Merge with master
johno Apr 4, 2019
d4b7361
Implement banner, add migration guide
johno Apr 4, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,9 @@ dist
build
.next
artifacts
.cache
public

# tmp
examples/vue
packages/vue
1 change: 1 addition & 0 deletions .eslintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ rules:
react/prop-types: off
react/display-name: off
react/no-children-prop: off
react/react-in-jsx-scope: off

settings:
react:
Expand Down
144 changes: 2 additions & 142 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,147 +2,7 @@

Hi! 👋
We’re excited that you’re interested in contributing!
Take a moment to read the following guidelines.
And thanks for contributing to **MDX**! 👏👌✨

If you’re raising an issue, please understand that people involved with this
project often do so for fun, next to their day job; you are not entitled to
free customer service.
[Read the guidelines][contributing]

## Table of Contents

* [Questions](#questions)
* [Contributions](#contributions)
* [Financial support](#financial-support)
* [Improve documentation](#improve-documentation)
* [Improve issues](#improve-issues)
* [Give feedback on issues and pull requests](#give-feedback-on-issues-and-pull-requests)
* [Write code](#write-code)
* [Running the tests](#running-the-tests)
* [Submitting an issue](#submitting-an-issue)
* [Submitting a pull request](#submitting-a-pull-request)
* [Project structure](#project-structure)
* [Releases](#releases)
* [Troubleshooting](#troubleshooting)
* [Resources](#resources)

## Questions

Please chat and ask questions on [spectrum][chat]!
Jump in there and lurk, talk to us, and help others.

## Contributions

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

### Financial support

It’s possible to support us financially by becoming a backer or sponsor of
unified through [Open Collective][collective].
With this support, we can pay for project leadership, finance non-coding work,
or to do fun things for the community like getting stickers for contributors.
You’ll be helping unified’s maintainers manage and improve existing projects,
and additionally support our work to develop new and exciting projects, such
as [micromark][].

### Improve documentation

As a user of this project you’re perfect for helping us improve our docs.
Typo corrections, error fixes, better explanations, new examples, etcetera.
Anything!

### Improve issues

Some issues lack information, aren’t reproducible, or are just incorrect.
Help make them easier to resolve.

### Give feedback on issues and pull requests

We’re always looking for more opinions on discussions in the issue tracker.

### Write code

Code contributions are very welcome. It’s often good to first create an issue
to report a bug or suggest a new feature before creating a pull request to
prevent you from doing unnecessary work.

## Running the tests

1. `yarn`
2. `yarn bootstrap`
3. `yarn test`

Tests for an individual package can be run as a yarn workspace:
`yarn workspace remark-mdx test`. To see what packages ar available to test
you can list out all workspaces with `yarn workspaces info`.

## Submitting an issue

* The issue tracker is for issues. Use chat for support
* Search the issue tracker (including closed issues) before opening a new
issue
* Ensure you’re using the latest version of our packages
* Use a clear and descriptive title
* Include as much information as possible: steps to reproduce the issue,
error message, version, operating system, etcetera
* The more time you put into an issue, the better we will be able to help you
* The best issue report is a [failing test][unit-test] proving it

## Submitting a pull request

* Non-trivial changes are often best discussed in an issue first, to prevent
you from doing unnecessary work
* For ambitious tasks, you should try to get your work in front of the
community for feedback as soon as possible
* New features should be accompanied with tests and documentation
* Don’t include unrelated changes
* Test before submitting code by running `yarn test`
* Write a convincing description of why we should land your pull request:
it’s your job to convince us

## Project structure

MDX is a monorepo that uses [lerna][].

* All packages are found in `./packages`
* All documentation is found in `./docs` and can be viewed with `yarn docs -- -o`
* There’s an `./examples` directory where examples for different tools and
frameworks

## Releases

In order to release a new version you can follow these steps:

* Draft a release for the next version (vX.X.X)
* Release a prerelease
* `yarn lerna publish`
* Select prepatch/preminor/premajor
* Sanity check in a project or two with the prerelease
* `yarn lerna publish`
* Publish release on GitHub

## Troubleshooting

If you’re having issues installing locally you might need to run
`yarn lerna exec yarn install` instead of `yarn bootstrap`
([issue][lerna-install]).

## Resources

* [Good first issues in the MDX repository](https://github.com/mdx-js/mdx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
* [Making your first contribution](https://medium.com/@vadimdemedes/making-your-first-contribution-de6576ddb190)
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
* [GitHub Help](https://help.github.com)

[unit-test]: https://twitter.com/sindresorhus/status/579306280495357953

[chat]: https://spectrum.chat/mdx

[collective]: https://opencollective.com/unified

[micromark]: https://github.com/micromark/micromark

[lerna]: https://lernajs.io

[lerna-install]: https://github.com/lerna/lerna/issues/1457
[contributing]: https://mdxjs.com/contributing
4 changes: 4 additions & 0 deletions docs/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
dist
node_modules
public
.cache
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.cache
public
112 changes: 0 additions & 112 deletions docs/_app.js

This file was deleted.

102 changes: 0 additions & 102 deletions docs/_ui.js

This file was deleted.

3 changes: 0 additions & 3 deletions docs/advanced/contributing.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/advanced/custom-loader.md

This file was deleted.

Loading