Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

asciidoc sample with tagged bash script #914

Open
jacobdotcosta opened this issue Sep 29, 2022 · 5 comments
Open

asciidoc sample with tagged bash script #914

jacobdotcosta opened this issue Sep 29, 2022 · 5 comments
Assignees
Labels
topic/weekly-update Your main weekly accomplishment. I will aggregate your different updates into one message

Comments

@jacobdotcosta
Copy link
Member

No description provided.

@jacobdotcosta jacobdotcosta added the topic/weekly-update Your main weekly accomplishment. I will aggregate your different updates into one message label Sep 29, 2022
@jacobdotcosta jacobdotcosta self-assigned this Sep 29, 2022
@jacobdotcosta
Copy link
Member Author

The tags aren't taken into account when rendering from asciidoc either into docbook or html.

The problem seems to be the asciidoc package.

asciidoc.noarch : Text based document generation

@jacobdotcosta
Copy link
Member Author

jacobdotcosta commented Sep 29, 2022

Testing with asciidoctor (rubygem-asciidoctor.noarch : A fast, open source AsciiDoc implementation in Ruby) it does take into account the tags.

$ asciidoctor -b docbook5 README.adoc 
$ pandoc --highlight-style=pygments -f docbook -t markdown-backtick_code_blocks README.xml -o README.2.md

Does render a markdown with only, although some information, such as image and source code titles, are interpreted incorrectly.

image.png

...should be...

image.png

@jacobdotcosta
Copy link
Member Author

Sections (L2 and L3 at least) include both the titme as well as the section id.

image.png

@jacobdotcosta
Copy link
Member Author

jacobdotcosta commented Sep 29, 2022

Exporting the document with asciidoctor directly to html format shows a well presented document.

$ asciidoctor -b html5 README.adoc

image.png

@cmoulliard
Copy link
Member

This is also what I did some years ago when I developed litoria and hyla tools able to generate from asciidoctor HTML generated documentation ;-)

Thee is also another option which is using github action to enhance the markdown or ascidoctor by looking to the snippet code and performing a find/replace. This is not also super convenient but at least we can continue to consult the content of the README on the github repo without the need to generate HTML and publish it somewhere (= where ???).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic/weekly-update Your main weekly accomplishment. I will aggregate your different updates into one message
Projects
None yet
Development

No branches or pull requests

2 participants