structurizr / atlassian-confluence-server

Structurizr macros for Atlassian Confluence.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Structurizr macro for Atlassian Confluence Server

This repository contains the source code for a macro that embeds diagrams from a Structurizr workspace into Confluence on Atlassian Confluence Server.

With Atlassian discontinuing Confluence Server, this repo (and the macro) is now unsupported, and will receive no updates. This macro is not compatible with Confluence Data Center.

Usage

When editing a page, type {structurizr or /structurizr (depending on the Confluence version) to insert the macro into your page. You will need the following information:

  • Workspace ID
  • Workspace API key (from the workspace settings page)
  • Diagram key (this is shown after the # symbol when viewing a diagram)

Please note that diagram previews do not always display - you may need to save/publish the page.

Prebuilt releases

Building from source

To build the macro from the source, you will need:

You will then need to setup your build environment; for example:

export JAVA_HOME=/jdk1.8.0_201.jdk
export ATLASSIAN_HOME=/atlassian-plugin-sdk-8.0.16/
export PATH=$ATLASSIAN_HOME/bin/:$PATH

And to build:

atlas-mvn package

If successful, you will see a file called structurizr-confluence-x.y.z.jar in the target directory.

About

Structurizr macros for Atlassian Confluence.

License:Apache License 2.0


Languages

Language:Java 98.2%Language:Shell 1.8%