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

Add Antora Atlas support to support partial site preview in the IDE #1250

Open
ahus1 opened this issue Dec 12, 2022 · 0 comments
Open

Add Antora Atlas support to support partial site preview in the IDE #1250

ahus1 opened this issue Dec 12, 2022 · 0 comments

Comments

@ahus1
Copy link
Contributor

ahus1 commented Dec 12, 2022

Why the new feature should be added

When an author opens a single component repository, they won't be able to validate references in the IDE to other components, and xref titles in the preview referencing other components won't show the title of the target page.

The Antora Atlas extension stores metadata about a site, so afterwards a partial build can occur. This could be leveraged by the IDE.

How the new feature should work

  • IDE retrieves the site URL from a playbook - alternative there could be a custom AsciiDoc attribute set for this
  • IDE retrieves the site manifest can caches it locally
  • When a component can't be resolved locally, it would use the site manifest to retrieve the information

Antora Atlas: https://gitlab.com/antora/antora-atlas-extension
Example: https://github.com/spring-projects/spring-security/blob/docs-build/antora-playbook.yml
Example Manifest: https://docs.spring.io/spring-security/reference/site-manifest.json

@ahus1 ahus1 changed the title Add Antora Atlas support Add Antora Atlas support to support partial site preview in the IDE Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant