https://github.com/stefapi/asciidoc_generator
Some scripts to generate docx odt pdf files with templates and styles from asciidoctor and preserving formatting like admonest
https://github.com/stefapi/asciidoc_generator
Last synced: 2 months ago
JSON representation
Some scripts to generate docx odt pdf files with templates and styles from asciidoctor and preserving formatting like admonest
- Host: GitHub
- URL: https://github.com/stefapi/asciidoc_generator
- Owner: stefapi
- License: mit
- Created: 2025-01-26T21:42:44.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-26T08:23:03.000Z (9 months ago)
- Last Synced: 2025-03-26T09:30:58.515Z (9 months ago)
- Language: Python
- Homepage:
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.asc
- License: LICENSE
Awesome Lists containing this project
README
== Software Description
This repository contains a script designed to generate high-quality documentation from Asciidoctor files with templating support. Key features include:
* **Company-Branded Templates**: Use your company's templates to generate documentation with consistent guard pages, headers, footers, and a final page.
* **Automatic Template Transformation**: The script automatically converts the document template into a template file and style file to ensure proper formatting and style consistency.
* **Multi-Format Output**: Starting from an ODT file generated with Pandoc, the script produces DOCX and PDF versions of the document.
=== Additional Features
The script also allows you to:
* Specify a **reviewer** and their **title** for the document.
* Specify an **approver** and their **title**.
* Add a **confidentiality policy** to the document.
* Preserve **revision marks** from the original Asciidoctor file and integrate them into a small table that can be positioned anywhere in your document.
== How to Use
An example of script usage is provided in the `Makefile`. This example demonstrates how to generate documentation using the script.
For details on creating and testing a document template, refer to the `README` file located in the `template` directory.
== Prerequisites
Before using the script, ensure the following dependencies are installed:
=== Required Software
* `python3` with the following tools: `awk`, `sed`
* `pandoc`
* `lua` engine for Pandoc (usually included in most distributions of Pandoc)
* `libreoffice`
* `asciidoctor` with the following extensions/modules:
** `asciidoctor-diagram`
** `asciidoctor-kroki` (if using Kroki for diagrams)
** `asciidoctor-include-ext` (if advanced inclusion features are needed)
** `asciidoctor-epub3` (if generating EPUB3 documents)
** `asciidoctor-reducer` (to flatten Asciidoctor files)
* `asciimath` (for AsciiMath support)
* `ascii` (general support)
* `rqrcode` and `barby` (for generating QR codes for document URLs)
=== Installation of Asciidoctor Modules
All Asciidoctor modules can be installed using the `gem install` command. For example:
[source,bash]
----
gem install asciidoctor-diagram
gem install asciidoctor-kroki
gem install asciidoctor-reducer
----
Ensure you install any additional modules as needed based on the features you plan to use.