SourceDocs

Product walkthrough

SourceDocs in a Confluence Cloud site, step by step (2 min 3 s, no sound).

What the video shows

  1. Typing /sourcedocs on a page lists the three macros.
  2. File from Git: paste the link of a file in GitHub, GitLab, Bitbucket Cloud or Azure DevOps; the preview renders a README with its images, badges and relative links.
  3. Diagram: Mermaid and PlantUML written in the page with a side-by-side live preview and example templates.
  4. Markdown: tables, task lists, code and diagrams written in the page.
  5. On the published page: zoom, full screen, SVG and PNG download.
  6. Source, branch and Refresh on every file from Git; an OpenAPI file rendered as an interactive API reference.
  7. Any other source file with syntax highlighting.
  8. Mermaid and PlantUML blocks inside Markdown files from Git.
  9. Dark mode.
  10. Export to Word: diagrams as images, OpenAPI as native headings and tables.
  11. Private repositories: one read-only token per provider, added by an admin.
  12. Company GitLab and GitHub Enterprise servers, approved by an admin in Atlassian's dialog.

Recorded on a Confluence Cloud test site with a non-production build of the app, so the macro names carry an environment suffix. Public example files: the Mermaid project README and the Swagger Petstore OpenAPI file.