-
Notifications
You must be signed in to change notification settings - Fork 10
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
Include AsciiDoc files as website input sources #12
Comments
Note that GitHub also supports view of asciidoc. I think it would be nice to align the Celix documentation to 1 format: markdown or asciidoc and because asciidoc is more flexible I would prefer asciidoc. Also note that the CLion / IntelliJ asciidoc plugin support transformation of markdown to asciidoc, which should make aligning the documentation format more easy .. if we move to asciidoc. |
I agree
Just for my information: what functionality do we want for Celix that AsciiDoc is better at than Markdown? It seems that Hugo supports AsciiDoc (see https://gohugo.io/content-management/formats/#list-of-content-formats ) when AsciiDoc is installed, but I would suggest to do some testing upfront to ensure that things will continue working |
I quote the following from a comprehensive article Compare AsciiDoc to Markdown:
An extra little advantage of using AsciiDoc is its inline plantuml support. Unfortunately, GitHub does not support plantuml Either AciiDoc + Plantuml or Github flavored Markdown + Mermaid, I am not sure which one we should pick. @pnoltes |
Right now in the Celix source tree there are 2 different input formats: Markdown and AsciiDoc. The Markdown files are already processed by Hugo but the AsciiDoc files are not.
It seems that Hugo is able to handle AsciiDoc as input files as well, see https://gohugo.io/content-management/formats/#list-of-content-formats
Test whether this works and whether the output is available on the website.
AsciiDoc input sources:
PR apache/celix#363 adds another AsciiDoc file for PushStreams, when merged that file should preferabbly be checked as well.
The text was updated successfully, but these errors were encountered: