Swimm currently supports integration with VSCode, and we're working really hard to fully support IntelliJ and Visual Studio as well. As they're ready, they will appear on the "Integrations" tab from any repository:
Links to install the extensions (from the official website, as well as within the IDE) are listed at the bottom of the page.
You can install the VSCode Plugin by visiting the IDE plugins page in Swimm's integration menu (recommended), or by searching for it in the VSCode market. Once Installed, you can see what files are documented in the code base by clicking on the Swimm view on the left-side:
And then you'll see links to documentation above any code referenced in a snippet:
Clicking on the 'hint' link will do one of two things, depending on how you have Swimm setup:
- If you have markdown export enabled, Swimm will load the corresponding Markdown file as a new tab in VSCode.
- If you don't have export enabled, or no doc for the link has been generated yet, you'll be taken to the document within the app itself.
We have a plugin that works across all IntelliJ platforms (IDEA, PHPStorm, others) which can be downloaded from their site and is also available from within the IDE interface to the marketplace.
Installed, it provides the same experience as the VSCode plugin, with the same contextual hints and on-click behavior:
|VSCode||Consuming (read-only) within the IDE||Available (Beta)||0.4.0|
|IntelliJ (all IDEs)||Consuming (read-only) within the IDE||Available (Beta)||0.5.0|
|Visual Studio||Consuming (read-only) within the IDE||In Development||TBD|
If you'd like us to support another IDE, please don't hesitate to reach out!