Product Guide

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started
added

Page Metadata

4 months ago by sean dokko

Today, we are fulfilling a much-needed customer feature request: customizing page metadata with an image, title, and description. You'll be able to customize the metadata with custom text and images using the new metadata editor modal.

Here are some samples of how cards look like on Twitter, Slack, and LinkedIn

On Twitter

On Twitter

On LinkedIn

On LinkedIn

Here is how you can start using it:

  1. Go to a page/custom page/changelog of your choosing
  2. Click on the downward chevron next to the "Update Doc" button (on the top right)
  3. Click on "Edit Metadata"
  4. Fill in the optional items and click on "Save"
Access the "Edit Metadata" modal by clicking on the down-chevron icon

Access the "Edit Metadata" modal by clicking on the down-chevron icon

To find out more about what this can do, you can check out our docs on it!