The Docs AddOn allows you to embed HTML, JavaScript, and CSS-based content in Confluence Cloud. The initial idea came from embedding JavaDocs. However, as JavaDocs is just HTML, JavaScript, and CSS, you can use the AddOn for embedding any type of such content.

FAQ

How to add your content to the Docs AddOn?

All content shown by the Docs AddOn needs to be uploaded as an attachment to the appropriate Confluence Page. The content itself needs to be packaged as ZIP Archive. The content’s entry page should be named “index.html“ and shall be located in the ZIP Archive’s root directory.

Note: The entry page’s name can be adjusted in the AddOn’s configurations.

Here is a simple docs example:

How to configure the Docs AddOn correctly?

The Docs AddOn provides a configuration bar to adapt it to your needs.

Image Removed

Image Added

Configuration Properties:

Glob Expression:

https://javapapers.com/java/glob-with-java-nio/

REST API

As all your Docs are organized as attachments on a Confluence Page basis, you can simply use Confluence’s standard REST API to add, delete or modify your content.

Here is the link to Confluence Cloud’s REST API documentation: https://developer.atlassian.com/cloud/confluence/rest/api-group-content---attachments/#api-wiki-rest-api-content-id-child-attachment-get