pwright / debbie-downstream

Replace antora links

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Antora links

Replace antora links using a csv file to define the substitutions.

If the following pattern is causing difficultly with reuse of Antora content, you can use a substition to replace it:

xref:<file>.adoc[]

You define what replaces this text in the sub.csv file.

Before starting, replace the symlink modules, currently set to ../debezium/documentation/modules with a symlink to your repo.

Install Vale.sh - A linter for prose. You might find Installing Vale with the RedHat package :: Vale for writers at Red Hat useful.

Install the python yaml library:

pip install pyyaml

Test your repo for antora links

Antora supports complex links, let's see what's in your repo:

./test-before.sh

Replace antora links with substitutions

The file sub.csv must contain all the substitutions required, the example shows

./sub.sh

Test your repo for antora links

All the unsupported links should now be replaced and you can check with:

./test-after.sh

About

Replace antora links

License:MIT License


Languages

Language:Python 97.9%Language:Makefile 1.5%Language:jq 0.4%Language:Shell 0.1%