->

How Swimm Works

Deploy continuous documentation within your workflow

Code Coupled Editor

Create Continuous Documentation that pulls real time code from all your Repositories. Search your entire codebase with ease. Group documents and external links to create Swimm Playlists that help new teammates dive right in.

Key features

  • tick icon
    Create documents with embedded live code snippets
  • tick icon
    Saved as Markdown and versioned on your own repository
  • tick icon
    All operating systems
  • tick icon
    Language Agnostic
  • tick icon
    Always up to date documentation
  • tick icon
    Fluid editing without needing to take your hands off the keyboard

Auto-sync & Git Checks

Swimm automatically checks any documentation pushed to git to make sure it’s up to date. If the code mentioned in your documentation changed, Swimm alerts you and lets you address the issue quickly and easily. This way both your code and your documentation are always accurate and up to date.

Key features

  • tick icon
    Github integration
  • tick icon
    Local Git Hooks
  • tick icon
    CI Integrations
  • tick icon
    Docs AutoSync to codebase
  • tick icon
    Smart text: Integrate code tokens and file paths into your text that will remain synced

IDE Integration

See your insights immediately, right in your IDE. These are not your average comments: Swimm indicators in your code open documentation right in your IDE, so everything fits into your CI.

Key features

  • tick icon
    VS Code integration
  • tick icon
    Keyboard interaction option
  • tick icon
    Whole team on the same page
  • tick icon
    IntelliJ integration
  • tick icon
    Atom integration
  • tick icon
    Always up to date documentation that is coupled with your code

Integrated into your CI/CD

Ci logoCi logoCi iconCi iconCi iconCi icon

Let’s Dive In!