{"_id":"@alandefreitas/antora-playbook-macros-extension","name":"@alandefreitas/antora-playbook-macros-extension","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"@alandefreitas/antora-playbook-macros-extension","version":"0.0.1","description":"Playbook Macros Extension for Antora","main":"lib/extension.js","scripts":{"test":"node test/extension.test.js"},"repository":{"type":"git","url":"git+https://github.com/alandefreitas/antora-playbook-macros-extension.git"},"keywords":["antora","extension","playbook","macros","documentation"],"author":{"name":"Alan de Freitas"},"license":"BSL-1.0","bugs":{"url":"https://github.com/alandefreitas/antora-playbook-macros-extension/issues"},"homepage":"https://github.com/alandefreitas/antora-playbook-macros-extension#readme","dependencies":{"process":"^0.11.10"},"devDependencies":{"js-yaml":"^4.1.0"},"_id":"@alandefreitas/antora-playbook-macros-extension@0.0.1","gitHead":"6cf5bf2cedab983360513002633f9f452a62b7c2","_nodeVersion":"20.16.0","_npmVersion":"10.8.1","dist":{"integrity":"sha512-rBGzR+WErYfW9SIogvdDL2ulNHZgniDlFRg1mjD6J+nlbU4JUv40L2xsL6tAJncSMQxmUIVhSuPM9VlLO0nKaw==","shasum":"023c2cbec5d56a3db9a4e9192fa98d1ab8baf1c4","tarball":"https://registry.npmjs.org/@alandefreitas/antora-playbook-macros-extension/-/antora-playbook-macros-extension-0.0.1.tgz","fileCount":9,"unpackedSize":19895,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIG3s2xbqkJgK8EdDN04tCdrlPUYfB5xdPRKGNRUpiSnnAiBGLif7vCyb/DBPrbd8qYtRPaP9azddKL8cxWJcFexo0Q=="}]},"_npmUser":{"name":"alandefreitas","email":"alandefreitas@gmail.com"},"directories":{},"maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/antora-playbook-macros-extension_0.0.1_1722986567533_0.8271623433010289"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-06T23:22:47.442Z","0.0.1":"2024-08-06T23:22:47.733Z","modified":"2024-08-06T23:22:47.974Z"},"maintainers":[{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"description":"Playbook Macros Extension for Antora","homepage":"https://github.com/alandefreitas/antora-playbook-macros-extension#readme","keywords":["antora","extension","playbook","macros","documentation"],"repository":{"type":"git","url":"git+https://github.com/alandefreitas/antora-playbook-macros-extension.git"},"author":{"name":"Alan de Freitas"},"bugs":{"url":"https://github.com/alandefreitas/antora-playbook-macros-extension/issues"},"license":"BSL-1.0","readme":"This allows you to use macros in your Antora playbook.\n\nConfiguration {#_configuration}\n=============\n\nnpm {#_npm}\n---\n\nInstall this extension\n\n``` {.bash}\nnpm i -D @alandefreitas/antora-playbook-macros-extension\n```\n\nPlaybook {#_playbook}\n--------\n\nAppend the following in your `playbook.yaml`:\n\n``` {.yaml}\nantora:\n  extensions:\n    - require: '@alandefreitas/antora-playbook-macros-extension' # \n      macros: # \n        key1: value1\n        key2: value2\n```\n\n-   \\<1\\> `npm` package name:\n    `@alandefreitas/antora-playbook-macros-extension` (required)\n\n-   \\<2\\> List of default macros and values (optional)\n\nUsing macros {#_using_macros}\n============\n\nAny value in the playbook can use a macro with the `${key}` syntax. The\nvalue will be replaced by the macro value as defined by one of the\nfollowing sources:\n\n1.  Environment variable\n\n2.  Uppercase environment variable\n\n3.  Asciidoc attribute\n\n4.  Default value\n\n5.  Predefined macros\n\nAsciidoc attributes comes from the `asciidoc.attributes` section of the\nplaybook. They can also be set in the antora command line using the\n`--attribute` option.\n\nDefault values are defined in the `macros` section of extension\nconfiguration. The provide a way to define default values for macros\nthat are not set in any other source.\n\nThe predefined macros are:\n\n-   `branch`: The current branch name as per\n    `git rev-parse --abbrev-ref HEAD`\n\n-   `commit-id`: The current commit hash as per `git rev-parse HEAD`\n","readmeFilename":"README.md"}