# @virmator/docs

> Default TS docs plugin for virmator.

Latest version **14.38.0** (published 2026-10-14) · (MIT OR CC0-1.0) license · 0 weekly downloads

## Install

```sh
npm install @virmator/docs
pnpm add @virmator/docs
yarn add @virmator/docs
bun add @virmator/docs
```

## Health

**Score 70/100 (B)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 14.38.0 |
| Published | 2026-10-14 |
| First published | 2024-08-03 |
| Weekly downloads | 0 |
| License | (MIT OR CC0-1.0) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22 |
| Dependencies | 6 |
| Unpacked size | 29.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | electrovir |
| Maintainers | electrovir |
| Keywords | virmator, docs, typedoc, documentation |

## Links

- npm: https://www.npmjs.com/package/@virmator/docs
- Repository: https://github.com/electrovir/virmator
- Issues: https://github.com/electrovir/virmator/issues
- npm.io page: https://npm.io/package/@virmator/docs

## Dependencies (6)

- [mri](https://npm.io/package/mri.md) ^1.2.0
- [runstorm](https://npm.io/package/runstorm.md) ^1.1.0
- [@virmator/core](https://npm.io/package/@virmator/core.md) ^14.38.0
- [@augment-vir/node](https://npm.io/package/@augment-vir/node.md) ^32.5.0
- [@augment-vir/assert](https://npm.io/package/@augment-vir/assert.md) ^32.5.0
- [@augment-vir/common](https://npm.io/package/@augment-vir/common.md) ^32.5.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 14.38.0 (latest) — 2026-10-14
- 14.37.2 — 2026-10-06
- 14.37.1 — 2026-09-30
- 14.37.0 — 2026-09-26
- 14.36.3 — 2026-09-15
- 14.36.2 — 2026-09-12
- 14.36.1 — 2026-09-12
- 14.36.0 — 2026-09-12
- 14.35.2 — 2026-09-10
- 14.35.1 — 2026-09-10
- 14.35.0 — 2026-09-10
- 14.34.0 — 2026-09-05
- 14.33.0 — 2026-08-30
- 14.32.1 — 2026-08-29
- 14.32.0 — 2026-08-19
- … 166 more at https://npm.io/package/@virmator/docs/versions

## README

# @virmator/docs

A default plugin for [virmator](https://www.npmjs.com/package/virmator).

## Available commands

-   **docs**

    Generates documentation using the typedoc package and inserts code examples into README files using the markdown-code-example-inserter package.

    -   Examples
        -   `virmator docs`
    -   Configs
        -   configs/typedoc.config.ts
    -   Deps
        -   [markdown-code-example-inserter](https://npmjs.com/package/markdown-code-example-inserter)
        -   [typedoc](https://npmjs.com/package/typedoc)
    -   Sub Commands

        -   **check**

            Checks that documentation is valid and passes all checks without generating documentation outputs.

            -   Examples
                -   `virmator docs check`

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