Zum Import und Export gibt es zusätzlich beispielsweise Pandoc.
Aus MS Word ist der Asciidoc-Export vergleichsweise einfach
pandoc another.docx -f docx -t asciidoc --wrap=none --markdown-headings=atx --extract-media=images -o another.en.adocUm von Asciidoc nach Word zu exportieren legt man einen Docbook-Export als Zwischenschritt ein:
asciidoctor --backend docbook pdf.en.adoc --out-file pdf.en.docbook
pandoc --from docbook --to docx --output pdf.en.docx --highlight-style espresso .\pdf.en.docbookWie PDF-Themes kann man sich auch Word-Vorlagedateien konfigurieren, dann sähe ein Export in etwa so aus:
pandoc -o my-custom-styles.docx \
--print-default-data-file reference.docx
An extension for Asciidoctor.js to convert diagrams to images using Kroki!
-
Simple
Designed to be small, yet full featured, Lunr enables you to provide a great search experience without the need for external, server-side, search services.
-
Extensible
Add powerful language processors to give more accurate results to user queries, or tweak the built-in processors to better fit your content.
-
Everywhere
Lunr has no external dependencies and works in your browser or on the server with node.js
Lunr provides a great search experience for readers without having to rely on external search services. With this extension, you can add offline, full-text search powered by Lunr to your Antora documentation site.
To add search functionality powered by Lunr to your Antora documentation site, you need to install this extension package, register the extension in your Antora playbook file, and add the search interface to the pages in your site. Let’s get started.
Antora Maven Plugin
This project provides the Antora Maven plugin that installs and runs Antora using a managed Node.js runtime.
The Antora Maven plugin adds support for using Antora from a Maven-based project by adding a goal named antora:antora that installs and invokes Antora as well as a lifecycle phase named antora that invokes this goal. You do not need Node.js preinstalled to use this plugin.
Refer to the documentation to learn how to install, configure, and use this plugin.
A documentation toolchain that helps technical writing teams create, manage, collaborate on, remix, and publish documentation sites sourced from a variety of versioned content repositories.
Antora’s site generator handles all aspects of creating a documentation site, from fetching and aggregating to converting and arranging the content to publishing the files of the generated site. This page describes that process in detail.
The default pipeline is opinionated to get you started as quickly as possible. But understand that Antora features a modular, open architecture. That means this architecture can accommodate specialized use cases by allowing custom Antora components, such as a validators, to be inserted into the pipeline at strategic points as needed. This page focuses on the core, built-in Antora components and capabilities in Antora.
Antora collects and processes content source files according to a set of hierarchical files and directories it expects to find at a content source root. This page introduces this hierarchy, the reserved directory and file names it employs, and the rules about which files get collected or ignored.
Antora employs both convention and configuration to aggregate content and generate your site. Before setting up or migrating your repositories, let’s review some key concepts that could impact how you organize your documentation projects and content files to work with Antora.
This plugin is designed to help to publish your Antora docs into Confluence. The main reason is, that we want to have a single source of truth for our documentation. We want to write our documentation in AsciiDoc and publish it to Confluence as some of our Stakeholders are using Confluence.
The captain offers the following options:
- Publish your whole Antora docs to Confluence
- Publish only selected pages/ folders, by using filters
- Control where the docs should be published by setting an
overall parent page in Confluence - Decide if you want to inform your readers that those pages are
- generated by automation by applying a banner.
You’d think an intuitive system for creating links between pages would be a central feature of every site generator. After all, that’s kind of what the web is all about. Sadly, it’s often an afterthought.
The current mechanisms tend to distract from writing. Each time you want to make a link to another page, you have to pause to compute a relative path and/or transform the path to a published URL in your head. If you move the page you’re editing, it may cause the relative path to shift, which means you have to go back and recompute those references.
It’s no wonder writers create broken links at an alarming rate or spend excessive amounts of time fixing broken links left behind by other writers. But we can’t fault the writers when it’s the system itself that’s broken. Let’s figure out a solution.
In a previous article, we established that content is sovereign, which means the site generator needs to gather content from various repositories and branches. In order for the generator to identify, aggregate, and catalog content partitioned in this way, the repositories must present a consistent structure. Otherwise, the generator isn’t going to know which files represent pages or which pages should be grouped together.
Ship your documentation as fast as your product.
We provide tools and workflows that help teams coordinate documentation initiatives across products and departments.
Antora erstellt Dokumentations-Websites für Nutzer. Gemäß des Docs-as-Code-Ansatzes werden alle Inhalte in AsciiDoc-Dateien in Git-Repositories versioniert und über CI/CD publiziert.
Die Nutzer erhalten eine übersichtliche Darstellung der Dokumentation im Browser mit Navigationsleiste, Suche und Querverweisen. Sie können zwischen verschiedenen Versionen der Dokumentation hin- und herschalten, um die für sie passenden Informationen zu finden. Open-Source-Projekte wie Camel, Debezium und Couchbase nutzen diese Lösung bereits.
Entwickler und Autoren der Dokumentation bearbeiten die Inhalte wie gewohnt in ihrer IDE und versionieren die Inhalte in der Versionsverwaltung mit Git. Alle Änderungen durchlaufen die bestehenden Code-Review- und Build-Prozesse des Projekts.
Dieser Vortrag stellt die Grundlagen eines Antora-Setups vor und zeigt alle Schritte von einer Dokumentationsänderung in der IDE bis hin zur aktualisierten Dokumentations-Website mit Continuous Integration und Delivery.
- Antora - The multi-repository documentation site generator for tech writers who writing in AsciiDoc
- Antora - Documentation
The multi-repository documentation site generator for tech writers who love writing in AsciiDoc.