Welcome to the Marketplace, where you can find pre-made, interactive MDX components that you can use to customize your ReadMe docs! Browse through the components/ directory, or contribute a component by opening a pull request.
At the moment, this is a copy-and-paste dealio. See a component you want to use? Just copy and paste the raw MDX syntax in to a new component from your project's content management admin. Now you can access it from the slash menu in any of your docs. (You can also upload a folder full of MDX components/ if you're using our new bidirectional git syncing workflow!)
Learn more about ReadMe's MDX features here!
If you're looking on where to start, check these out!
- 📊
<Compatibility>: Show what plans a feature is available for, or explain what user roles have access to it. - 🏞️
<SnapSlider>: Let users scroll through a handful of images, rather than having to pick just one! - 👩🏻💻
<Terminal>: A faux terminal that shows input and output, as well makes it easy to copy each command. - 👆
<KeyPress>: Show some special content if the user hits a key-combo of your choice. - 🛠️
<ExampleComponent>: If you're looking to build your own and need a simple example component, this is a great place to start!
Have a cool idea for a component that you think could be useful to the wider ReadMe community? We're accepting contributions to this repo; just open up a PR with your new MDX component and we'll do our best to review it and get back to you. And if you have any questions, just open an issue.
Stay tuned! We have big plans for the ReadMe Marketplace, so check back soon.
- install Marketplace components directly from your ReadMe project
- expanded offering, including integrations for third party services and more