# @govuk-react/api-docs

> govuk-react: A port of the govuk-frontend components for React using styled-components.

Latest version **0.10.7** (published 2024-05-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @govuk-react/api-docs
pnpm add @govuk-react/api-docs
yarn add @govuk-react/api-docs
bun add @govuk-react/api-docs
```

Provides the command `doc-component`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.10.7 |
| Published | 2024-05-13 |
| First published | 2018-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 14 |
| Unpacked size | 28.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Alasdair McLeay |
| Maintainers | loque-, steve_sims, petelockey, penx, marksy |

## Links

- npm: https://www.npmjs.com/package/@govuk-react/api-docs
- Homepage: https://github.com/govuk-react/govuk-react#readme
- npm.io page: https://npm.io/package/@govuk-react/api-docs

## Dependencies (14)

- [glob](https://npm.io/package/glob.md) ^7.1.2
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [react](https://npm.io/package/react.md) ^18.2.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [react-is](https://npm.io/package/react-is.md) ^18.2.0
- [commander](https://npm.io/package/commander.md) ^11.1.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [typescript](https://npm.io/package/typescript.md) ^5.4.2
- [@babel/node](https://npm.io/package/@babel/node.md) 7.22.19
- [govuk-react](https://npm.io/package/govuk-react.md) ^0.10.7
- [glob-promise](https://npm.io/package/glob-promise.md) ^6.0.5
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) 7.23.1
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.0
- [react-docgen-typescript](https://npm.io/package/react-docgen-typescript.md) ^2.1.0

## Recent versions

- 0.10.7 (latest) — 2024-05-13
- 0.6.0-rc.1 (next) — 2019-02-28
- 0.10.6 — 2023-10-01
- 0.10.5 — 2022-11-22
- 0.10.4 — 2022-10-08
- 0.10.3 — 2022-08-20
- 0.10.2 — 2022-08-19
- 0.10.1 — 2022-04-08
- 0.10.0 — 2021-10-07
- 0.9.1 — 2021-09-06
- 0.9.0 — 2021-05-30
- 0.8.0 — 2021-05-16
- 0.7.2 — 2019-07-04
- 0.7.1 — 2019-05-24
- 0.7.0 — 2019-03-15
- … 30 more at https://npm.io/package/@govuk-react/api-docs/versions

## README

# api-docs

This package helps generate API docs in markdown based on our React component definitions.

## Contributing

> These contributing docs are for contributing to the api-docs package. If you want to update the API docs instead, you just need to run `yarn docs`.

First, run `yarn` to install the relevant dependencies.

After you change this package, to see the effect of your changes on the docs you must run `yarn build` to output files into `/dist`, before regenerating the docs with `yarn docs`.

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