Skip to main content

ReadMe integration

Setting up the ReadMe​

  1. Go to Integrations. Click “Add” on the ReadMe card.

    ReadMe integration card

  2. Enter your API key.

    1. You can find your API key or generate one by following the instructions here.

    ReadMe integration inputs

  3. Optionally, adjust the settings. For more details on settings, read the section below.

  4. Click “Connect”. Your docs will start syncing. Once synced, you can click on the card to see the imported docs.

    ReadMe import success

Automatic syncs

If on a Growth or Enterprise plan, you can set up your content to sync automatically — either daily or weekly.

ReadMe integration settings​

  1. Sync frequency: The frequency of syncs. Note: automatic syncs are only available on Growth and Enterprise tiers.

    1. Manual — synced manually
    2. Weekly — automatically synced weekly
    3. Daily — automatically synced daily

  2. Default visibility: If set to "Live", your articles will immediately be searchable in Spotlight.

    Integration settings

FAQs​

Can I sync ReadMe subpages?​

No, but let us know if you want to sync them!