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

Support for Antora project structure, to render previews in full #409

Open
digi-brain opened this issue May 26, 2021 · 1 comment
Open
Labels
💬 discussion Disccussion on new features, projects, etc... ✨ enhancement

Comments

@digi-brain
Copy link

Is your feature request related to a problem? Please describe

When we write with Asciidoc but for Antora, the preview doesn't doesn't recognise and render elements that depend upon the Antora project structure. This makes it much more difficult to compose good source files than it would otherwise be, and forces us to build locally often just to check basic things.

Describe the solution you'd like

Provide Antora support; in particular, support the project structure so that the preview will correctly render elements such as:

  • includes
  • attributes that are defined in the playbook, not just in the page
  • xrefs between pages/modules/components

Describe alternatives you've considered

I know of no alternatives, other than to switch to IntelliJ and use the Asciidoc plugin which does support Antora. IntelliJ AsciiDoc Plugin: Antora

Additional context

From the Antora Zulip chat forum:

As the current maintainer of the IntelliJ AsciiDoc plugin and its Antora support: If someone wants to tackle some of the features for the VS Code plugin, I'm happy to guide and discuss how this was implemented for the IntelliJ plugin. Mentioning me on GitHub issues as "@ahus1" usually works well.

@digi-brain digi-brain added 💬 discussion Disccussion on new features, projects, etc... ✨ enhancement labels May 26, 2021
@digi-brain
Copy link
Author

digi-brain commented May 26, 2021

By the way, love the plugin, would just love it even more with Antora support! Keep up the great work.

@danyill danyill mentioned this issue Sep 8, 2021
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💬 discussion Disccussion on new features, projects, etc... ✨ enhancement
Projects
None yet
Development

No branches or pull requests

1 participant