Skip to content

Commit

Permalink
Update docToolRec.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
khazelton authored May 17, 2023
1 parent a1cbf34 commit 93a1d7b
Showing 1 changed file with 1 addition and 41 deletions.
42 changes: 1 addition & 41 deletions docToolRec.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ _2023-05-14 13:48:53 Draft documentation tool option comparisons_

What features of Confluence are used in our wiki content? Are there counterparts in the other options under consideration?

Specific Items
Specific Requirements

. A documentation entry system with source files under version control
. A process that creates a web accessible documentation site from the source repository
Expand All @@ -35,8 +35,6 @@ Specific Items
.. Substitutes punctuations with typographic entities
.. Github emojis



==== III. Static site generators as documentation substrate

. MkDocs
Expand All @@ -47,42 +45,4 @@ Specific Items
. Antora
. Hugo

==== IV. Comparison of text entry, editing, preview, publication, and CI/CD tools: Markdown-based vs Asciidoc-based

[cols=3*,stripes=odd]
|===
^| *FEATURE/ASPECT* ^|*MARKDOWN* ^| *ASCIIDOC*

|Basic text entry, editing, and preview
|https://code.visualstudio.com/docs/languages/markdown[VS Code support for Markdown]
|https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode[Asciidoc support for VS Code]

| Distinguishing features
| Broad adoption, greater volume of published content, simple syntax for basic features, enhanced features available in various markdown flavors +
| Complex tables, asides, definition lists, includes, sidebars, table of contents, live snippets from source code, anchors, in-file metadata, attribute/variable support, ifdef/ifndef for conditional inclusion

| Flavors and Standards
| Markdown (MD) plus varieties: Github Flavored Markdown (GFM), GitLab Flavored Markdown (GLFM, based on https://commonmark.org/[CommonMark])
| Asciidoc specification is governed by the https://asciidoc-wg.eclipse.org/[Asciidoc Working Group] under Eclipse

|Publication process
|Markdown -> Jekyll -> GitHub Pages +
Markdown -> Jekyll -> GitLab Pages +
Output: HTML, pdf, more via Pandoc
|Asciidoc -> https://antora.org/[Antora] -> GitLab Pages +
Asciidoc -> Antora -> GitHub Pages +
Output: HTML, pdf, Docbook, man pages, EPUB3, Reveal.js via Asciidoctor CLI +
Multi-repository documentation sites via Antora

|CI/CD support
|Jekyll to GitHub Pages via Github Actions; To GitLab pages via https://docs.gitlab.com/ee/user/markdown.html[GitLab Flavored Markdown] (based on Kramdown) +
|Antora to GitLab Pages via .gitlab-ci.yml playbook; to GitHub pages via Github Actions with .nojekyll directive

|Conversion between markdown and asciidoc
|https://github.com/asciidoctor/kramdown-asciidoc[markdown to asciidoc]
|https://github.com/opendevise/downdoc[asciidoc to markdown]

|
|HTML, pdf, Docbook, man pages, EPUB3, Reveal.js via Asciidoctor CLI

|===

0 comments on commit 93a1d7b

Please sign in to comment.