Feature Update (6/24/19)
Insert your ReadMe changlog into your product with the embed widget!
Navigate to Documentation > Changelog.
The Changelog is shared across all versions. Adding a post will add it to all versions. Deleting a post will remove it everywhere.
Posts will appear from the most recent to the most outdated, both on the backend and the frontend.
Changelog uses the same editor as our Documentation component with the added option to choose a Changelog Type
Modify the metadata from the dropdown arrow next to Update Post
Change the Post Date to any time or the Posted By to any Project Member
Changelog posts are ordered by date. Change the Post Date to change the order.
Now your users can view your ReadMe changelog without leaving your product!
Without any CSS styling, this is how the Changelog widget will appear your site:
Users can subscribe to your changelog, provided that your project is public. Simply add .rss to the end of your changelog URL.
Changelog RSS URL
Enterprise project with a custom domain
Once you have your URL, you can use any RSS feed widget/tool to input the URL and generate HTML to embed it (here's an example)!
If you use ReadMe for an internal documentation project (restricting access to Project Members only, or Site-Wide password), the RSS feed will require authentication to your project. This means the RSS cannot be used by third-party readers.
Updated 5 months ago