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

Add @brillout/vite-plugin-mdx #88

Merged
merged 2 commits into from
Feb 12, 2021
Merged

Add @brillout/vite-plugin-mdx #88

merged 2 commits into from
Feb 12, 2021

Conversation

brillout
Copy link
Contributor

@brillout brillout commented Feb 9, 2021

Add ressource https://github.com/brillout/vite-plugin-mdx.

General

✏️ Mark the necessary items without changing the structure of the PR template.

  • Pull request template structure not broken

Type

ℹ️ What types of changes does your code introduce?

👉 Put an x in the boxes that apply

  • Fix
  • Feature

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

👉 Put an x in the boxes that apply.

  • Title as described.
  • Make sure you put things in the right category!
  • Always add your items to the end of a list.
  • Your plugin/tool is working with Vite 2.0 and onward.

Open Source

  • Link description does not contain a link to an author / third-party resource
  • The documentation (README) contains a description of the project, illustration of the project with a demo or screenshots and a CONTRIBUTING section
  • The documentation is in English.
  • The project is active and maintained.
  • The project accepts contributions.
  • Not a commercial product

Copy link
Member

@antfu antfu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is Vue fully supported? (saw WIP on your README). If so, please provide more info about how to configure it to support MDX v1/v2 for React/Vue. Thanks.

@brillout
Copy link
Contributor Author

brillout commented Feb 11, 2021

Vue is not entirely working right now, but I'll finish the implementation when enough users upvote brillout/vite-plugin-mdx#3.

how to configure it to support MDX v1/v2

MDX is a peer dependency, so it can be used with any MDX version. This doesn't really need any explanation as the Getting Started section starts with:

  1. Install @brillout/vite-plugin-mdx as well as MDX.
    npm install @brillout/vite-plugin-mdx
    npm install @mdx-js/mdx
    npm install @mdx-js/react

@brillout/vite-plugin-mdx has already been used with v1 as well as v2.

@brillout
Copy link
Contributor Author

brillout commented Feb 11, 2021

I just added following note to the getting started, to make it clearer.

You can install MDX v1 as well as MDX v2; @brillout/vite-plugin-mdx works with both.

@antfu
Copy link
Member

antfu commented Feb 12, 2021

So, can you move your plugin into the React section and remove the description about Vue? Thanks.

@brillout
Copy link
Contributor Author

Done

@brillout
Copy link
Contributor Author

I also improved the commit messages.

@antfu antfu merged commit 87d46f5 into vitejs:master Feb 12, 2021
@brillout brillout deleted the patch-1 branch July 13, 2021 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants