Page Metadata and SEO

What is it?

The Update Metadata is a modal that you can use to specify the title, image, and description of the page. This feature is available for Pages, Custom Pages, and Changelogs.

You can update the page metadata using the Edit Metadata modal on Pages. By default, a title and description will be based on the page title and description. That can be overwritten, using the Update Metadata modal.

Update Metadata ModalUpdate Metadata Modal

Update Metadata Modal

How to use

Here is how to access the Edit Metadata modal:

  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.
To access the modal, click on the chevron next to the save button, and click on Edit Metadata.To access the modal, click on the chevron next to the save button, and click on Edit Metadata.

To access the modal, click on the chevron next to the save button, and click on Edit Metadata.

📘

Details

  • Setting the metadata title will also set the tag of the page.
  • Changing the "Posted Date" and "Author" of a post is only available to Changelogs.

Examples

Here are some examples of how they will look on Twitter, Slack, and LinkedIn

A Twitter CardA Twitter Card

A Twitter Card

On SlackOn Slack

On Slack

On LinkedInOn LinkedIn

On LinkedIn

Meta Tags for SEO

Individual Pages

ReadMe automatically populates the meta title tag and meta description tag of each page with content from the Title and Description fields.

21732173

📘

No Description

When the Description field is empty, ReadMe uses the first 300 characters of the body of your page as the Meta description instead.

Try viewing the source code for this page! This is what you'll see:

<meta property="og:title" content="Meta Tags">
<meta property="og:description" content="This description goes in the Meta description of the page">

Project-level Metadata

The description that you provide under Configuration > Project Settings will populate the meta name tag on all pages in your ReadMe project.

13701370
<meta name="description" content="Beautiful documentation made easy.">