Skip to main content

Embed Swimm docs into other platforms

Swimm provides seamless integration with various platforms, allowing you to embed your documentation directly where you need it. This guide will walk you through the process of embedding Swimm docs into Confluence and Notion documents.


You will need to sign in to your Swimm account and authorize your git hosting service.

Confluence​

Introduction​

Integrating Swimm with Confluence enables you to bring your documentation directly into your Confluence pages, ensuring that your team has easy access to the most up-to-date information.

Steps to embed Swimm docs in Confluence​

  1. Open your Confluence page where you want to embed the Swimm doc.
  2. Click on the + sign in the toolbar to add a Smart Link.
  3. Copy and paste the url for the Swimm doc you want to embed.
Analyze your repository with Ask Swimm

Success! Your Swimm doc is now embedded in your Confluence page.

Jira​

Introduction​

Embedding Swimm docs in Jira allows your team to reference detailed documentation directly within Jira issues, enhancing collaboration and issue resolution.

Steps to embed Swimm docs in Jira​

  1. Open/create the Jira issue where you want to embed the Swimm doc.
  2. Paste the url for the Swimm doc you want to embed in the issue editor.
  3. Convert the url into the Embed view.
Analyze your repository with Ask Swimm

Success! Your Swimm doc is now embedded in your Jira issue.

Notion​

Introduction​

Embedding your Swimm documentation in Notion pages ensures that your team has all the resources they need in one place.

Steps to embed Swimm docs in Notion​

  1. Open your Notion page where you want to embed the Swimm doc.
  2. Type /embed and select it from the dropdown menu.
  3. Paste the URL of your Swimm doc into the embed URL field.
  4. Click Embed link to insert the Swimm doc into your Notion page.
Analyze your repository with Ask Swimm

Success! Your Swimm doc is now embedded in your Notion page.

No Git access? Share docs with everyone in your external platform​

Swimm's Sharing Internally feature, you can also take advantage of Swimm-hosted documentation.

When you share a doc link that is hosted by Swimm, your entire organization will be able to read your Swimm document without any Git permissions in your external platform. This ensures that all team members can access and benefit from the documentation, regardless of their Git permissions, in your external platform (Confluence, Jira, Notion).

A Swimm user account is still required.

Benefits​

BenefitDescription
No Git Hosting RequiredSelected documents are hosted on Swimm's servers, eliminating the need for a Git repository.
Ease of AccessTeam members can view embedded documentation without requiring a git hosting login through Swimm's web app.
Seamless IntegrationEmbedding these docs is as simple as copying and pasting the Swimm document's link into your preferred platform.

How to share Swimm-hosted docs​

Follow the steps outlined above for your respective external platform. When you reach the step to paste the Swimm doc URL, use the URL of the Swimm-hosted document you want to embed. After converting the doc to share it, notice shared-docs in that doc's URL, like below:

https://app.swimm.io/workspaces/{workspaceId}/shared-docs/{docId}

Swimm hosted doc url

This document is automatically kept up to date using Swimm.