Edit
View
Run

Confluence Codepen

Introduction

This repository is a plugin for easily making Codepen sandboxes of snippets in Confluence documentation, and was developed by Adrian Smith.

This code relies on several external libraries:

Jsoup - A great library for JQuery style HTML processing in Java
Atlassian SDK - Used to interact with Confluence
Apache Commons Lang - Used for HTML parsing

If you encounter issues with this plugin, contact Adrian Smith via adrian@smithdev.io. Pull Requests welcome.

Building from Source

Prerequisites: The Atlassian SDK

The lastest work is on the development branch. The master branch represents the code for the last release.

First, move into the codepen folder and execute atlas-run. That will bring up an instance of Confluence.

Next, in another command shell execute atlas-package. That will package all of the plugins as defined in the local directory's pom.xml file

Usage

The Codepen macro is used to wrap a related set of Confluence Code macros and provide a special link to Codepen which will allow readers of the page to experiment with the code in a live sandbox. The macro will sent the contents from the first CSS Code macro, the first Javascript Code macro and the first HTML Code contained in it's body. All other macros in the body will be rendered as normal on the Confluence page, but will not be included in the special link to Codepen.

As the Codepen macro is looking for the first HTML, CSS and Javascript Code macros, the language for those instances must be explicitly specified in the Code macro (or that block will be ignored).

if you omit one of the code macros the codepen macro will simply use the 1 or 2 blocks provided, and the codepen page generated will not have code for those languages.