# @antora/file-publisher

> Publishes the publishable files in the virtual file catalog(s) to the destination(s) specified in the playbook.

Latest version **3.2.2** (published 2026-10-30) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install @antora/file-publisher
pnpm add @antora/file-publisher
yarn add @antora/file-publisher
bun add @antora/file-publisher
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 3.2.2 |
| Published | 2026-10-30 |
| First published | 2021-12-01 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=20.0.0 |
| Dependencies | 4 |
| Unpacked size | 16.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | OpenDevise Inc. |
| Maintainers | mojavelinux, graphitefriction |
| Keywords | antora, antora-component, publisher, files, documentation, static site, web publishing |

## Links

- npm: https://www.npmjs.com/package/@antora/file-publisher
- Repository: https://gitlab.com/antora/antora
- Homepage: https://antora.org
- Issues: https://gitlab.com/antora/antora/issues
- npm.io page: https://npm.io/package/@antora/file-publisher

## Dependencies (4)

- [yazl](https://npm.io/package/yazl.md) ~3.3
- [vinyl](https://npm.io/package/vinyl.md) ~3.0
- [@antora/expand-path-helper](https://npm.io/package/@antora/expand-path-helper.md) ~3.0
- [@antora/user-require-helper](https://npm.io/package/@antora/user-require-helper.md) ~3.0

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 3.2.2 (latest) — 2026-10-30
- 3.2.0-rc.3 (testing) — 2026-08-12
- 3.2.1 — 2026-10-01
- 3.2.0 — 2026-08-29
- 3.2.0-rc.2 — 2026-06-20
- 3.2.0-rc.1 — 2026-06-19
- 3.1.15 — 2026-05-26
- 3.2.0-alpha.12 — 2026-05-12
- 3.2.0-alpha.11 — 2025-11-27
- 3.2.0-alpha.10 — 2025-10-03
- 3.1.14 — 2025-10-03
- 3.1.13 — 2025-09-30
- 3.2.0-alpha.9 — 2025-08-11
- 3.1.12 — 2025-08-06
- 3.1.11 — 2025-08-06
- … 31 more at https://npm.io/package/@antora/file-publisher/versions

## README

# Antora File Publisher

The File Publisher is a component in Antora responsible for publishing (i.e., writing) the publishable files in the virtual file catalog(s) to the destination(s) specified in the playbook.
This component supports different destination types (via providers) such as a filesystem directory or an archive file.
More than one destination may be specified.
Custom providers can be used to add support for additional destinations.

[Antora](https://antora.org) 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](https://asciidoctor.org).

## Copyright and License

Copyright (C) 2017-present [OpenDevise Inc.](https://opendevise.com) and the [Antora Project](https://antora.org).

Use of this software is granted under the terms of the [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/) (MPL-2.0).

---
_Source: https://npm.io/package/@antora/file-publisher · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._