Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

FAQ

How to add your content to the Docs AddOn?

All content shown by the Docs AddOn need to be uploaded as attachment to the appropriate Confluence Page. The content itself needs to be packacked 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.

Live Demo

Ricebean docs macro
entry-pageindex.html
height400

REST API

As all your Docs can be uploaded, modified and deleted using a REST API

Authentication

(see Basic auth for REST APIs)

Example

curl -D- \ -u <your_email@domain.com>:<your_user_api_token> \ -X GET \ -H "Content-Type: application/json" \ https://<your-domain.atlassian.net>/wiki/rest/api/spaceare organized as attachments on a Conflunce 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

Table of Contents

Table of Contents