Publish articles to ReadMe

Publish a Clevera article as a guide in your ReadMe project, filed under the guide category you pick. Screenshots are uploaded to ReadMe, and the video plays at the top of the guide.

Before you start#

• In Clevera: the workspace is on the Pro or Custom plan, and you are an owner or admin to connect ReadMe. Anyone in the workspace can publish once it's connected. See Publish articles to your other tools.
• In ReadMe: a project you can manage, with at least one category in its Guides section. One key connects one project.
• A current ReadMe project: Clevera publishes through ReadMe's current (v2) API, which ReadMe offers to projects on ReadMe Refactored. Projects still on ReadMe's older platform can't be connected.
• Version: Clevera publishes to your project's main (stable) version of the Guides.
• An article: generate it first. Publishing sends the article; a video is only carried as a player inside it.

Find your ReadMe API key#

In your ReadMe project, open Configuration → API Keys, then copy a key (create one if the list is empty). The key gives full access to that project, so keep it private.

Connect ReadMe#

1. Open the connect window#

   In Clevera, click your workspace name in the sidebar, choose Integrations, find ReadMe and click Connect. The Connect ReadMe window says "Paste a key. We check it before saving anything."

2. Paste and check the key#

   Paste the key into API key and click Check key. When ReadMe accepts it you see "Key accepted." and your project under Sites to publish to.

   

3. Connect#

   Click Connect. You see "ReadMe connected." and ReadMe appears under Connected with your project's name.

The key doesn't expire on Clevera's side. To connect a different project, use Reconnect on the ReadMe connection and paste that project's key; it replaces the old one.

Publish an article to ReadMe#

1. Open the Publish tab#

   In the editor, click Share → Publish and click Publish next to ReadMe.

2. Choose a guide category#

   Project shows the connected project. Pick a Guide category: "The article goes in the Guides section, under this category." If you see "No guide categories yet", create one in ReadMe first.

   

3. Publish#

   Click Publish. If a guide with the same address already exists, choose what to do (see Update a guide). The guide opens in a new tab and you see "Published to ReadMe."

The guide's address comes from its title: "Set up billing" becomes /docs/set-up-billing on your docs site.

What the guide looks like in ReadMe#

The guide title is the article's title. If the video's link is shared (Share → Link → General access set to Anyone with the link), the guide starts with an embedded player.

Screenshots are uploaded to ReadMe, so they keep working even if you delete the article in Clevera. A screenshot that fails to upload is linked from Clevera instead and stays valid for about a year.

Update a guide#

Publishing only goes one way. The guide doesn't update when you edit the article in Clevera, and edits made in ReadMe never come back to Clevera. After you edit the article, publish it again.

• The same article again: if this article was published to ReadMe before, Clevera updates that guide in place: same address, new title and content. This happens even if you choose Publish as a new article.
• Another article with the same title: Clevera finds the guide with the same address anywhere in your Guides and asks "An article with this title already exists in ReadMe." Replace the existing article overwrites that guide. Publish as a new article creates a new guide under the title you enter, with its own address.

Changes made in ReadMe since the last publish are overwritten when Clevera updates a guide.

Disconnect and revoke access#

1. In Clevera, open Integrations, click ReadMe, then Disconnect and confirm. Guides you already published stay in ReadMe.
2. In ReadMe, open Configuration → API Keys and delete the key you gave Clevera.

Troubleshooting#

Related#