Skip to content

Latest commit

 

History

History
67 lines (50 loc) · 14.5 KB

comparison_with_other_tools.md

File metadata and controls

67 lines (50 loc) · 14.5 KB

Comparison with other tools

Comparison with other tools used in java world. The comparison performed in 2023 June

Comparison table

bsorrentino/maven-confluence-plugin confluence-publisher/confluence-publisher md2conf/md2conf zeldigas/text2confl qwazer/markdown-confluence-gradle-plugin
Since 2009 2016 2022 2022 2016
Stars on github 60 180 1 7 10
Maintainer single man 3 core developers, only 1 active in 2022 single man single man single man
Status Maintained, accepting PRs Maintained, accepting PRs Maintained, accepting PRs Maintained, accepting PRs Deprecating
Packaging maven-plugin maven-plugin, cli tool, docker maven-plugin, cli tool, docker cli tool, docker gradle-plugin
Supported input formats Markdown, Confluence wiki, Storage Format AsciiDoc Markdown, Confluence wiki, Storage format Markdown, AsciiDoc, Confluence wiki, Storage format Markdown
Markdown or AsciiDoc processor Commonmark Asciidoctorj Flexmark Flexmark, Asciidoctorj Pegdown
Diagram support No Plantuml Externalized Plantuml, Mermaid, https://kroki.io No
Idempotence confluence client Partial, saves result of publishing in local file storage. It is not CI-friendly. Yes. Saves content hash code to remote confluence Yes. Saves content hash code to remote confluence (copied from confluence-publisher) Yes. Saves content hash code to remote confluence (design copied from confluence-publisher) no
Standalone confluence client No No Yes Yes no
Automatic page structure from files layout No Yes Yes Yes yes, limited
Dump functionality No No Yes, the whole file-tree Yes, limited. one page only no
Default format to publish into Confluence Confluence wiki Storage format Confluence wiki Storage format Confluence wiki
Confluence plugin support Yes, scrolling version, blogposts No optional plantuml server-side rendering no
Additional features Yes, for example gitlog. Attempt to automatically create release notes based on git log parsing No no Yes. text2confl flavored markdown to support confluence macros no
Proc (opinion-based) Nice plugin with long history, active maintaner, a lot of features Robust plugin, relatively big community Auto-indexing, CI-friendly, easy to extend, standalone confluence Very nice tool with a lot of supported formats. Tries to solve the same problems as this project. Focused on polyglot usage scenarios. Just do its job
Cons (opinion-based) Low extendability (opinion-based). I failed to add Idempotence feature because of code complexity and a lot of dirty code. There were main reason to start md2conf. No support for markdown, Confluence client cannot be used as standalone tool Single man support on irregular basis. The tool is not widely used. Need to collect feedback from the community. Single man support on irregular basis. The tool is not widely used. No active development, usage of deprecated pegdown

Markdown flavored comparison

Feature bsorrentino/maven-confluence-plugin md2conf/md2conf zeldigas/text2confl
Custom macros Use confluence wiki macros markup, wrapped as HTML comment <!-- {jira:ABC-1} --> Use confluence wiki macros markup, wrapped as HTML comment <!-- {jira:ABC-1} --> Special link references without actual links. For example [JIRA key=ABC-1]
Adding raw confluence storage formatting into markdown No No Yes
Admonitions Yes, see below No Yes, based on admonitions in flexmark-java (see example below)
Table of contents No No Yes, based on ToC extension from flexmark-java
Popular confluence macros No No Yes. status, mentioning user, render date with Confluence style. Based on text2confl docs

Some examples

Admonitions in bsorrentino/maven-confluence-plugin

> **info:** title
>
> Body Text
>

Admonitions in flexmark-java

!!! info

    Information message