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

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

Open
man-at-home opened this issue Dec 9, 2019 · 2 comments
Open

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

man-at-home opened this issue Dec 9, 2019 · 2 comments
Labels
enhancement Task Type: New features, additional options for existing features, etc. plugins Project Type: Plugins, Language extensions refactor Task Type: Refactoring, code cleanup, etc.
Milestone

Comments

@man-at-home
Copy link

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

  • usage of :outfilesuffix: attribute with asciidoc (or possibility to set attributes in orchid gradle task)
  • enable include: (opt in) while processing with asciidoctor (correct unsafe mode?)
  • nice to have: copy referenced images to target path
@cjbrooks12 cjbrooks12 added enhancement Task Type: New features, additional options for existing features, etc. plugins Project Type: Plugins, Language extensions refactor Task Type: Refactoring, code cleanup, etc. labels Dec 9, 2019
@cjbrooks12 cjbrooks12 added this to the 0.18.1 milestone Dec 9, 2019
@cjbrooks12 cjbrooks12 modified the milestones: 0.18.1, 0.18.2 Dec 22, 2019
@tomb50
Copy link

tomb50 commented Jan 7, 2020

+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 cjbrooks12 modified the milestones: 0.18.2, 0.18.3 Jan 23, 2020
@cjbrooks12
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Task Type: New features, additional options for existing features, etc. plugins Project Type: Plugins, Language extensions refactor Task Type: Refactoring, code cleanup, etc.
Projects
None yet
Development

No branches or pull requests

3 participants