orchidhq / Orchid

Build and deploy beautiful documentation sites that grow with you
https://orchid.run
GNU General Public License v3.0
518 stars 53 forks source link

enhance asciidoc markup support: linking, including, images #340

Open man-at-home opened 4 years ago

man-at-home commented 4 years ago

enhancement

enable inter document xref linking with <<>> and include: tags, enhance image:support in asciidoc markup pages for orchid

why

this would enable to use already existing asciidoc content to be included in orchid sites.

showcase

i added a little bit asciidoc to the orchid starter project, using those tags

https://github.com/man-at-home/OrchidStarter/blob/asciidoc-linking-showcase/src/orchid/resources/pages/asciidoc/asciidocpage.adoc

solution ideas

tomb50 commented 4 years ago

+1 for this request (trying to adopt Orchid and we needed embedded code samples),

I've pushed a PR for a small change to specify the AsciDoc API safe mode level, which should help satisfy some of the suggestions here.

347

cjbrooks12 commented 4 years ago

The latest release, 0.18.2, now has support for the include::[] macro. Cross-linking and images are proving to be a bit more tricky, but I'm going to keep working to see what I can do. And thank you @tomb50 for the safe-mode PR! That went a long way in helping me figure out how to properly configure and extend Asciidoctorj for this.