Asciidoctor-confluence is a ruby gem that takes Asciidoc files, parse them using Asciidoctor and push the result into Confluence.
This gem currently supports Asciidoctor 1.5.2
This gem is compatible with Confluence 5.x
First you need to download and install the gem
gem install asciidoctor-confluenceThen to create a page
asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USERNAME --password PASSWORD file.adocTo update a page
asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USERNAME --password PASSWORD --update file.adoc
#or
asciidoctor-confluence --host HOSTNAME --spaceKey SPACEKEY --title TITLE --username USERNAME --password PASSWORD --update --pageid PAGEID file.adocHere is the list of arguments that can used with this gem
| Argument | Is mandatory | Role | Example |
|---|---|---|---|
host |
yes |
The hostname of the Confluence instance |
|
spaceKey |
yes |
The space wihtin the page will be created |
|
title |
yes |
The title of the Confluence page |
|
username |
no |
The username to use if the page has write restrictions |
|
password |
no |
The password associated to the account used to login into Confluence |
|
update |
false |
Indicate that the page must be updated instead of created. No values are required for this option |
|
pageid |
no |
The ID of the page you want to update, if it’s not provided it will be determined using the space key and the title |
If you want to try asciidoctor-confluence you can either download the gem:
gem install asciidoctor-confluenceOr install from the source
-
Install the gem locally (at the moment it has not been publish to rubygem)
-
Clone the github repository locally
git clone https://github.com/gscheibel/asciidoctor-confluence.git -
Built it
gem build asciidoctor-confluence.gemspec -
Install it
gem install ./asciidoctor-confluence.0.0.2.gem -
To check it has been done correctly
asciidoctor-confluence -vshould displayasciidoctor-confluence: 0.0.2
-
-
Have a Confluence instance
-
If you don’t have a Confluence server, you can use a Docker container (e.i.: https://registry.hub.docker.com/u/cptactionhank/atlassian-confluence/), the option requires therefore an Atlassian account so it can generate a trial licence key.
-
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent