docToolchain is composed of two parts:
-
doctoolchain which is the toolchain used to create your documentation
-
the docToolchain shell wrapper script installed in your project which calls the toolchain
The use of this setup has the following advantages:
-
It’s easy to build your documentation within your project folder.
-
Ensures that everyone in the project uses the same docToolchain version.
-
Keeps all docToolchain technology out of your project repository.
-
Facilitates the installation of the docToolchain if not installed.
-
Makes it easier to upgrade to never versions of docToolchain.
There are times when you’ll want to publish your docs to Confluence, such as when you work in a team where not everyone wants to work with Git. docToolchain lets you publish your Git-based docs to Confluence alongside manually edited Confluence pages.
When you work in a restricted environment where you don’t have direct access to the internet, you might need a self-contained version of docToolchain. A version which does not need to download dependencies but already has them on board.
Asciidoctor-ConfluencePublisher is a command line tool that parse asciidoc files, generate confluence compatible html and upload the content and attachment to confluence.
This repo inspired by confluence-publisher
It requires Ruby 2.x. works for Confluence 6+.
The Confluence Publisher allows documentation written in AsciiDoc and versioned directly with the documented code base to be published to a Confluence space. It converts the resulting AsciiDoc HTML output to XHTML compatible with Confluence, manages included resources as Confluence attachments and ensures that only content modified since the last publication is again re-published.
The Confluence Publisher has been tested with Confluence 6.0.5Supported Features
Currently, the Confluence Publisher supports the following AsciiDoc features:
- Pages
- Includes
- Sections
- Paragraphs
- Tables
- Images
- Listings
- Admonitions
- External Links
- PlantUML
- Attachments
- Table of Contents
- Additional Features
The Confluence Publisher uses AsciidoctorJ and therefore supports documentation written using the Asciidoctor syntax. See Asciidoctor User Manual for more information about Asciidoctor.
Create awesome docs the easy way!
docToolchain is a collection of scripts that makes it easy to create and maintain powerful technical documentation. Built on best-of-breed open source technologies, we deliver the best docs toolchain so you don’t have to.