https://github.com/readmeio/marketplace

https://github.com/readmeio/marketplace

mdx

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/readmeio/marketplace
• Owner: readmeio
• Created: 2024-09-12T21:06:31.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-05-29T18:22:29.000Z (29 days ago)
• Last Synced: 2025-05-29T19:45:38.625Z (29 days ago)
• Topics: mdx
• Language: MDX
• Homepage:
• Size: 256 KB
• Stars: 4
• Watchers: 6
• Forks: 4
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ReadMe Marketplace 

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][components], or [contribute](#contributing) a component by opening a pull request.

### Using a Component

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][mdx docs]!

### Some of our favs

If you're looking on where to start, check these out!

- 📊 **[``](./components/Compatibility)**: Show what plans a feature is available for, or explain what user roles have access to it.

- 🏞️ **[``](./components/SnapSlider)**: Let users scroll through a handful of images, rather than having to pick just one!

- 👩🏻‍💻 **[``](./components/Terminal)**: A faux terminal that shows input and output, as well makes it easy to copy each command.

- 👆 **[``](./components/KeyPress)**: Show some special content if the user hits a key-combo of your choice.

- 🛠️ **[``](./components/ExampleComponent)**: If you're looking to build your own and need a simple example component, this is a great place to start!

### Contributing

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

[components]: https://github.com/readmeio/marketplace/tree/main/components

[mdx docs]: https://docs.readme.com/main/docs/building-custom-mdx-components