# @uidu/docs

> Utilities for building documentation

Latest version **0.12.1** (published 2024-11-26) · ISC license · 0 weekly downloads

## Install

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

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 0.12.1 |
| Published | 2024-11-26 |
| First published | 2018-11-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 13 |
| Unpacked size | 66.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | uidu |
| Maintainers | apuntovanini, flavio-scimeca, bacco40 |

## Links

- npm: https://www.npmjs.com/package/@uidu/docs
- Repository: https://github.com/uidu-org/guidu.git#main
- Homepage: https://github.com/uidu-org/guidu/tree/main#readme
- Issues: https://github.com/uidu-org/guidu/issues
- npm.io page: https://npm.io/package/@uidu/docs

## Dependencies (13)

- [@uidu/code](https://npm.io/package/@uidu/code.md) ^1.0.1
- [string-raw](https://npm.io/package/string-raw.md) ^1.0.1
- [@uidu/theme](https://npm.io/package/@uidu/theme.md) ^0.13.1
- [@uidu/button](https://npm.io/package/@uidu/button.md) ^1.11.1
- [@uidu/tooltip](https://npm.io/package/@uidu/tooltip.md) ^0.12.1
- [codesandboxer](https://npm.io/package/codesandboxer.md) ^1.0.3
- [react-feather](https://npm.io/package/react-feather.md) ^2.0.10
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.26.0
- [react-markings](https://npm.io/package/react-markings.md) ^1.3.0
- [pretty-proptypes](https://npm.io/package/pretty-proptypes.md) ^1.7.0
- [styled-components](https://npm.io/package/styled-components.md) ^5.3.11
- [@uidu/section-message](https://npm.io/package/@uidu/section-message.md) ^0.13.1
- [react-syntax-highlighter](https://npm.io/package/react-syntax-highlighter.md) ^15.6.1

## Recent versions

- 0.12.1 (latest) — 2024-11-26
- 0.12.0 — 2024-11-26
- 0.11.4 — 2024-09-03
- 0.11.3 — 2024-04-29
- 0.11.2 — 2024-04-29
- 0.11.1 — 2024-04-20
- 0.11.0 — 2024-03-21
- 0.10.2 — 2024-02-22
- 0.10.1 — 2024-01-22
- 0.10.0 — 2023-12-14
- 0.9.0 — 2023-10-26
- 0.8.0 — 2023-10-10
- 0.7.0 — 2023-09-07
- 0.6.0 — 2023-08-27
- 0.5.31 — 2023-06-15
- … 101 more at https://npm.io/package/@uidu/docs/versions

## README

# guidu

![banner](https://travis-ci.org/uidu-org/guidu.svg?branch=main) [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat)](https://github.com/RichardLitt/standard-readme) [![Netlify Status](https://api.netlify.com/api/v1/badges/f216cce3-c149-4be4-8d3a-cc87cb744a18/deploy-status)](https://app.netlify.com/sites/guidu/deploys) [![Crowdin](https://badges.crowdin.net/guidu/localized.svg)](https://crowdin.com/project/guidu)

> Guidu is uidu's design system library

TODO: Fill out this long description.

## Table of Contents

- [Install](#install)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)

## Install

```
git clone https://github.com/uidu-org/guidu.git
cd guidu
yarn install
```

## Usage

Documentation is package specific, browse https://uidu.design to see all the packages in action.

## Maintainers

[@uidu-org](https://github.com/uidu-org)
[@apuntovanini](https://github.com/apuntovanini)
[@fsansalvadore](https://github.com/fsansalvadore)

## Contributing

Start all packages (not reccommended)

```
yarn start
```

Start specific folders

```
yarn start:forms
yarn start:data
yarn start:dashboards
```

or specific packages

```
yarn start modal-dialog field-geosuggest
```

Pull requests are more than welcome, we're currently making this repo more contributors-friendly.

## Common pitfalls

## License

MIT © 2019 uidu.org

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