npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@alandefreitas/antora-playbook-macros-extension

v0.0.1

Published

Playbook Macros Extension for Antora

Downloads

288

Readme

This allows you to use macros in your Antora playbook.

Configuration {#_configuration}

npm {#_npm}

Install this extension

npm i -D @alandefreitas/antora-playbook-macros-extension

Playbook {#_playbook}

Append the following in your playbook.yaml:

antora:
  extensions:
    - require: '@alandefreitas/antora-playbook-macros-extension' # 
      macros: # 
        key1: value1
        key2: value2
  • <1> npm package name: @alandefreitas/antora-playbook-macros-extension (required)

  • <2> List of default macros and values (optional)

Using macros {#_using_macros}

Any value in the playbook can use a macro with the ${key} syntax. The value will be replaced by the macro value as defined by one of the following sources:

  1. Environment variable

  2. Uppercase environment variable

  3. Asciidoc attribute

  4. Default value

  5. Predefined macros

Asciidoc attributes comes from the asciidoc.attributes section of the playbook. They can also be set in the antora command line using the --attribute option.

Default values are defined in the macros section of extension configuration. The provide a way to define default values for macros that are not set in any other source.

The predefined macros are:

  • branch: The current branch name as per git rev-parse --abbrev-ref HEAD

  • commit-id: The current commit hash as per git rev-parse HEAD