{"_id":"@cppalliance/antora-playbook-macros-extension","name":"@cppalliance/antora-playbook-macros-extension","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.2":{"name":"@cppalliance/antora-playbook-macros-extension","version":"0.0.2","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/cppalliance/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/cppalliance/antora-playbook-macros-extension/issues"},"homepage":"https://github.com/cppalliance/antora-playbook-macros-extension#readme","dependencies":{"process":"^0.11.10"},"devDependencies":{"js-yaml":"^4.1.0"},"_id":"@cppalliance/antora-playbook-macros-extension@0.0.2","gitHead":"a8e75e4a0549b2749c767325fef31460698dad67","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-0R3DSbMfADQs4E74N2bOLXDiCFth5ze1jVs8HSgpZ7U5vCayudhc77Fj/7yzy2iWvup9VfiE9QvoE5hIVxJEVg==","shasum":"f0b05a8da353f578319c766bd2272a9d7e8ea82c","tarball":"https://registry.npmjs.org/@cppalliance/antora-playbook-macros-extension/-/antora-playbook-macros-extension-0.0.2.tgz","fileCount":9,"unpackedSize":20121,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCt/7eeL2M40MOzfG+3o4zUwjRWqhNsUhLAEaVaIvbAwwIgdUQ79LOd7nunROA845RVTQtQ4auPsfy0sVklEvrJoWM="}]},"_npmUser":{"name":"alandefreitas","email":"alandefreitas@gmail.com"},"directories":{},"maintainers":[{"name":"samdarwin","email":"sam@cppalliance.org"},{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/antora-playbook-macros-extension_0.0.2_1727292238885_0.6365837594564403"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-25T19:23:58.758Z","0.0.2":"2024-09-25T19:23:59.037Z","modified":"2024-09-25T19:23:59.314Z"},"maintainers":[{"name":"samdarwin","email":"sam@cppalliance.org"},{"name":"alandefreitas","email":"alandefreitas@gmail.com"}],"description":"Playbook Macros Extension for Antora","homepage":"https://github.com/cppalliance/antora-playbook-macros-extension#readme","keywords":["antora","extension","playbook","macros","documentation"],"repository":{"type":"git","url":"git+https://github.com/cppalliance/antora-playbook-macros-extension.git"},"author":{"name":"Alan de Freitas"},"bugs":{"url":"https://github.com/cppalliance/antora-playbook-macros-extension/issues"},"license":"BSL-1.0","readme":"# Antora Playbook Macros Extension\n\n\nThis allows you to use macros in your Antora playbook.\n\nConfiguration {#_configuration}\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"}