@antora/cli
Advanced tools
The command line interface (CLI) for Antora.
This package provides the antora command (i.e., bin script) to run Antora.
It does not include the site generator, which must be installed separately.
Antora is a modular static site generator designed for creating documentation sites from AsciiDoc documents. Its site generator aggregates documents from versioned content repositories and processes them using Asciidoctor.
To run Antora, you need both the CLI and a site generator.
Once these packages are installed, you can use the antora command to generate your site.
Let’s start by installing the CLI.
npm i -g @antora/cli
This package adds the antora command to your PATH.
You can check by running:
antora -v
Next, install a site generator. The site generator provided by Antora will be sufficient for most users.
npm i -g @antora/site-generator
The antora command (specifically the implicit generate subcommand) will look for this package by default.
To run Antora, you’ll need a playbook file and at least one content (source) repository. Consult the quickstart to find an example.
Once you have your content sources set up, point the antora command at your playbook file:
antora antora-playbook.yml
The antora command will output the generated site to the build/site folder by default.
Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.
Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0).
FAQs
The command line interface for Antora.
We found that @antora/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers 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
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.