{"_id":"@axoniq/antora-vale-extension","_rev":"2-cb53e058e7d38fb70a69ed66d07a5111","name":"@axoniq/antora-vale-extension","dist-tags":{"latest":"0.1.2"},"versions":{"0.1.0":{"name":"@axoniq/antora-vale-extension","version":"0.1.0","description":"An extension to run Vale.sh as part of an Antora build","license":"ISC","author":{"name":"AxonIQ","url":"https://axoniq.io"},"contributors":[{"name":"Milen Dyankov","email":"milendyankov@gmail.com"}],"main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["antora","antora-component","antora-extension","vale"],"_id":"@axoniq/antora-vale-extension@0.1.0","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-+0thsPbyTkVYNAgCNqrZbJSAvzBx7ZgCAL1+b1HDKhGm50YcNjwIbGVFMFKDibGyU3fnfjFCHFz5IVUZsp1bcg==","shasum":"0017ae3cd0e78b69dd29d2e3a8a89c2b2ab28a73","tarball":"https://registry.npmjs.org/@axoniq/antora-vale-extension/-/antora-vale-extension-0.1.0.tgz","fileCount":2,"unpackedSize":1709,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDLtha8Pc5Awpjd7d00pPiSE+7O03WEtaymTrbSN2cVngIhAKtW7lHV1FEOguNtHVzEpKw4swyAsMK1vVHpGb17/4e5"}]},"_npmUser":{"name":"axoniq-devrel","email":"devrel@axoniq.io"},"directories":{},"maintainers":[{"name":"axoniq-devrel","email":"devrel@axoniq.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/antora-vale-extension_0.1.0_1686318236033_0.7469506598237439"},"_hasShrinkwrap":false},"0.1.1":{"name":"@axoniq/antora-vale-extension","version":"0.1.1","description":"An extension to run Vale.sh as part of an Antora build","license":"ISC","author":{"name":"AxonIQ","url":"https://axoniq.io"},"contributors":[{"name":"Milen Dyankov","email":"milendyankov@gmail.com"}],"homepage":"https://github.com/AxonIQ/antora-vale-extension#readme","repository":{"type":"git","url":"git+https://github.com/AxonIQ/antora-vale-extension.git"},"bugs":{"url":"https://github.com/AxonIQ/antora-vale-extension/issues"},"main":"index.js","keywords":["antora","antora-component","antora-extension","vale"],"gitHead":"f1121a494ad65434534f5ff9e87016e6eb359835","_id":"@axoniq/antora-vale-extension@0.1.1","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-BkbtPQgkG/KsKbGudMiWeW7mwOEVEyC87caxkjjUErK8/b8eEtGTmPOhvqEEoRHWwWI8oy7jMmVCjQ/Etm87Kg==","shasum":"cbdf251bf83e3aa65ad48375164263edb16e0a36","tarball":"https://registry.npmjs.org/@axoniq/antora-vale-extension/-/antora-vale-extension-0.1.1.tgz","fileCount":4,"unpackedSize":3851,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDe+WCG3L0zIl6DtiQ8rM1VU/bSxxPvaWOTfKCoD42PKAIgY3tHQZwBcXNaEsPfiYEoFB6ygdodL3F+0zSU8lY56yA="}]},"_npmUser":{"name":"axoniq-devrel","email":"devrel@axoniq.io"},"directories":{},"maintainers":[{"name":"axoniq-devrel","email":"devrel@axoniq.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/antora-vale-extension_0.1.1_1686322707459_0.8280797313127846"},"_hasShrinkwrap":false},"0.1.2":{"name":"@axoniq/antora-vale-extension","version":"0.1.2","description":"An extension to run Vale.sh as part of an Antora build","license":"ISC","author":{"name":"AxonIQ","url":"https://axoniq.io"},"contributors":[{"name":"Milen Dyankov","email":"milendyankov@gmail.com"}],"homepage":"https://github.com/AxonIQ/antora-vale-extension#readme","repository":{"type":"git","url":"git+https://github.com/AxonIQ/antora-vale-extension.git"},"bugs":{"url":"https://github.com/AxonIQ/antora-vale-extension/issues"},"main":"index.js","keywords":["antora","antora-component","antora-extension","vale"],"dependencies":{"replace-in-files":"^3.0.0"},"gitHead":"8358c9411a9cb0813658c92112c2487c08eec0ae","_id":"@axoniq/antora-vale-extension@0.1.2","_nodeVersion":"16.20.2","_npmVersion":"8.19.4","dist":{"integrity":"sha512-zmWFf/9xOpg4R1cbQ23oiUTHLBHQanAPdb+GtQBLwkaofzH0++a79cur7xEOtXojeBfTkF3OdPgVfoXlnComUg==","shasum":"a7d8bf59f9b4b267615becb8bb07ac4089314fd9","tarball":"https://registry.npmjs.org/@axoniq/antora-vale-extension/-/antora-vale-extension-0.1.2.tgz","fileCount":4,"unpackedSize":4711,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCqlQXwFQ52w4jVN473eEB8BHsoX2YjiPepM32iTcvL8QIgbM7JWRmjyjCXySCDDzdp90BXwCtX+C3RhCVJ8cuzNJQ="}]},"_npmUser":{"name":"axoniq-devrel","email":"devrel@axoniq.io"},"directories":{},"maintainers":[{"name":"axoniq-devrel","email":"devrel@axoniq.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/antora-vale-extension_0.1.2_1695212500043_0.1525216334277637"},"_hasShrinkwrap":false}},"time":{"created":"2023-06-09T13:43:55.985Z","0.1.0":"2023-06-09T13:43:56.203Z","modified":"2023-09-20T12:21:40.393Z","0.1.1":"2023-06-09T14:58:27.666Z","0.1.2":"2023-09-20T12:21:40.194Z"},"maintainers":[{"name":"axoniq-devrel","email":"devrel@axoniq.io"}],"description":"An extension to run Vale.sh as part of an Antora build","keywords":["antora","antora-component","antora-extension","vale"],"contributors":[{"name":"Milen Dyankov","email":"milendyankov@gmail.com"}],"author":{"name":"AxonIQ","url":"https://axoniq.io"},"license":"ISC","readme":"# Antora Vale.sh Extension\n\n[Vale.sh](https://vale.sh/) helps you maintain a consistent and on-brand voice by allowing you to create your own custom rules.\nThis extension runs Vale.sh during the build process. The build will fail if it finds any errors.\n\n## Prerequisites\n\nYou must use at least Node.js 16 and Antora 3 to use this extension.\nYou also need Vale installed and accessible on the machine you run the build.\n\n## Installation\n\nInstalling the extension package into your [playbook project](https://docs.antora.org/antora/3.0/playbook/use-an-existing-playbook-project/):\n\n```console\n$ npm i @axoniq/antora-vale-extension\n```\n\nYou also have the option of installing the extension globally by adding the `-g` flag to the `npm i` command:\n\n```console\n$ npm i -g @axoniq/antora-vale-extension\n```\n\n## Register the extension\n\nYou need to [register the extension](https://docs.antora.org/antora/3.0/extend/register-extension/) with Antora before it can use it.\nOpen the Antora playbook file and add the extension as follows:\n\n**antora-playbook.yml**\n\n```yaml\nantora:\n  extensions:\n  - id: vale\n    require: '@axoniq/antora-vale-extension'\n    enabled: true\n    vale_config: .vale.ini\n    update_styles: true\n```\n\n - The `vale_config` parameter specifies where Vale’s configuration is read from.\n- The `update_styles` boolean parameter dictates if remote styles should be updated (effectively running `vale sync`) before the build.\n\n","readmeFilename":"README.md","homepage":"https://github.com/AxonIQ/antora-vale-extension#readme","repository":{"type":"git","url":"git+https://github.com/AxonIQ/antora-vale-extension.git"},"bugs":{"url":"https://github.com/AxonIQ/antora-vale-extension/issues"}}