Swimm is the only documentation tool built for developers

The official Swimm extension for VS Code.

Internal documentation you can trust

Create, maintain, and discover documentation – without ever leaving the IDE.

Keep that documentation up to date as part of your workflow, even before pushing changes.

How Swimm documentation is different:

	Swimm	Other tools
Rich text editor & slash commands	✅	✅
Maintain up-to-date documentation	✅	❌
Discover docs in the IDE	✅	❌
Create & edit docs in the IDE	✅	❌
CI integrations	✅	❌

Features

Create docs

Create documentation with Swimm's rich text editor. Document complex flows spanning multiple files and repos with rich content that interact with the code and automatically updates as you make changes.

Create internal documentation with Swimm

Maintain docs

Validate and update documentation locally and as part of your CI workflow, fixing simple errors automatically and only alerting you with significant changes.

Keep internal documentation up to date with Swimm

Discover docs

Find the right documentation, at the right time — right next to the relevant code. When you see a wave, that means that documentation related to that particular section of code exists.

Discover internal documentation with Swimm

Quick start

Login or register to Swimm
Install the plugin
Find, create, and update documentation

FAQ

Read the FAQ here.

Community

Feel free to contact the Swimm team here

💡Tip:

Add a .vscode/extensions.json file to your repo to access Swimm Docs and notify your team about the Swimm plugin. More details on workspace recommended extensions here.

View Swimm's change log.

Happy Swimming!