# @appium/docutils

> Documentation generation utilities for Appium and related projects

Latest version **3.0.1** (published 2026-09-24) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @appium/docutils
pnpm add @appium/docutils
yarn add @appium/docutils
bun add @appium/docutils
```

Provides the command `appium-docs`.

## Health

**Score 80/100 (A)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2026-09-24 |
| First published | 2022-04-20 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | ^20.19.0 \|\| ^22.12.0 \|\| >=24.0.0 |
| Dependencies | 10 |
| Unpacked size | 282 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 22037 |
| Author | https://github.com/appium |
| Maintainers | jlipps, nick.mokhnach, kazucocoa |
| Keywords | android, automation, firefoxos, ios, javascript, selenium, testing, webdriver |

## Links

- npm: https://www.npmjs.com/package/@appium/docutils
- Repository: https://github.com/appium/appium
- Homepage: https://appium.io
- Issues: https://github.com/appium/appium/issues
- npm.io page: https://npm.io/package/@appium/docutils

## Dependencies (10)

- [diff](https://npm.io/package/diff.md) 9.0.0
- [yaml](https://npm.io/package/yaml.md) 2.9.1
- [yargs](https://npm.io/package/yargs.md) 18.1.0
- [consola](https://npm.io/package/consola.md) 3.4.2
- [lilconfig](https://npm.io/package/lilconfig.md) 3.1.3
- [type-fest](https://npm.io/package/type-fest.md) 5.10.0
- [teen_process](https://npm.io/package/teen_process.md) 4.2.1
- [yargs-parser](https://npm.io/package/yargs-parser.md) 22.0.0
- [@appium/support](https://npm.io/package/@appium/support.md) 7.2.8
- [normalize-package-data](https://npm.io/package/normalize-package-data.md) 8.0.0

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 3.0.1 (latest) — 2026-09-24
- 4.0.0-beta.2 (beta) — 2026-10-05
- 2.0.0-rc.1 (rc) — 2025-08-14
- 4.0.0-beta.1 — 2026-09-27
- 4.0.0-beta.0 — 2026-09-19
- 3.0.0 — 2026-08-24
- 2.5.2 — 2026-07-25
- 2.5.1 — 2026-06-18
- 2.5.0 — 2026-06-18
- 2.4.3 — 2026-05-31
- 2.4.2 — 2026-05-07
- 2.4.1 — 2026-05-06
- 2.4.0 — 2026-05-06
- 2.3.1 — 2026-04-23
- 2.3.0 — 2026-04-09
- … 91 more at https://npm.io/package/@appium/docutils/versions

## README

# @appium/docutils

> Documentation-building utilities for Appium

[![NPM version](https://img.shields.io/npm/v/@appium/docutils.svg)](https://npmjs.org/package/@appium/docutils)
[![Downloads](https://img.shields.io/npm/dm/@appium/docutils.svg)](https://npmjs.org/package/@appium/docutils)

## Setup for Main Appium Docs

This package does not need to be run directly. Instead, execute this command in the
`packages/appium` directory:

```bash
npm run dev:docs:en
```

> [!NOTE]
> This will only build the English docs. See the `scripts` field of the `package.json` for
other languages.

## Setup for Appium Drivers and Plugins

See the Appium docs on [Building Documentation](http://appium.io/docs/en/latest/developing/build-docs/).

## License

Apache-2.0

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