question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Disable Antora support for files ignored by Antora

See original GitHub issue

Why the new feature should be added

  1. According to Antora documentation Antora ignores any files stored in hierarchy that begin with a dot (.). If there is a file that starts with a dot, it will be ignored by Antora and won’t be published.

  2. Antora has nav files that have the following structure:

    .Nav title
    * xref:Annotation.adoc[Annotation]
    * xref:Introduction.adoc[Introduction]
    ** xref:Scope.adoc[Scope]
    
  3. I’ve made a copy of a nav file with the following structure:

    .Nav title
    * include::pages/Annotation.adoc[Annotation]
    * include::pages/Introduction.adoc[Introduction]
    ** include::pages/Scope.adoc[Scope]
    
  4. I gave the copied and altered nav file a name starting with a dot so it will be ignored by Antora.

  5. Opened the project with IntelliJ, it is displayed like this: not desired

  6. If I copy the module folder where this file is located and put it separately from Antora, then open it with IntelliJ, it will open as desired: desired

How the new feature should work

It appears that some of the Antora settings interfere with the AsciiDoc document’s settings. Is it possible to (automatically or manually) disable Antora support for files that should be ignored by Antora i.e. starting with a dot?

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:9 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
ahus1commented, Jun 30, 2021

I created a follow-up issue for this to take care of soft-set attributes in the Antora component descriptor: #798

0reactions
Grolribasicommented, Jun 30, 2021

You’re probably right. I didn’t think of the other side of the case when someone actually wants it to work this way. And it is not recommended to use == for headings and amend it with :leveloffset: anyway. I will close the issue then.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Standard File and Directory Set :: Antora Docs
This page introduces this hierarchy, the reserved directory and file names it employs, and the rules about which files get collected or ignored....
Read more >
antora/users - Gitter
My first public Antora documentation component is upcoming: ... Can asciidoctor-pdf support the partial$ syntax e.g. include::partial$changelog.adoc[] ?
Read more >
Page attribute to suppress publishing a page (#499) - Antora
Activity · people use underscore file names to prevent publishing and rename the files when they are ready. Include stubs might help? ·...
Read more >
RELATIVE_INCLUDE variable breaking Antora builds #156
in Antora, the concept of a file path is murky at best because antora ... use !include_many that Kroki and Antora ignores the...
Read more >
Standard File and Directory Set - InfraDoc
Antora ignores any files stored in hierarchy that begin with a dot ( . ) or which don't have a file extension. These...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found