@neo4j-antora/antora-add-notes
Advanced tools
Add asciidoc blocks into the top of pages based on page attributes
Readme
Use the antora-add-notes extension to add asciidoc into the top of pages.
The extension uses Page Attributes to define content to be added to the top of a page, immediately below the title.
Define attributes in an Antora playbook, antora.yml, or asciidoc page header.
Use the page-add-notes-module attribute to specify the name of the module that contains the asciidoc you want to add. If page-add-notes-module is not specified, the ROOT module is used.
page-add-notes-module: my-notes@
page-add-notes-tags: tag-1;tag-2@
Tagged sections are read from {page-add-notes-module}:partial$/notes.adoc.
To include multiple tags, add the tags as a list, for example page-add-notes-tags: review;preview.
By default the note is displayed in all versions of all pages.
Use the page-add-notes-versions attribute to specify which versions of the HTML pages you want the note to be displayed on.
If you do not include this attribute, notes will be added to pages in all versions.
page-add-notes-versions: ['5', '4.4']
Create modules/my-notes/partials/notes.adoc with the following content:
# tag::preview[]
[NOTE]
====
This is preview content
====
# end::preview[]
In your Antora playbook file, add an asciidoc attribute - page-add-notes-module: my-notes
In your Antora playbook file, add an asciidoc attribute - page-add-notes-tags: preview
Use Antora to generate HTML.
FAQs
Add asciidoc blocks into the top of pages based on page attributes
The npm package @neo4j-antora/antora-add-notes receives a total of 121 weekly downloads. As such, @neo4j-antora/antora-add-notes popularity was classified as not popular.
We found that @neo4j-antora/antora-add-notes demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST's new AI Risk Management Framework aims to enhance the security and reliability of generative AI systems and address the unique challenges of malicious AI exploits.
Security News
This episode of the Risky Biz podcast discusses how the rise of small open source packages and the shift towards individual maintainers makes the ecosystem more vulnerable to supply chain attacks.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.