# @core-ds/components

> ## Docz site

Latest version **0.1.5** (published 2020-08-06) · 0 weekly downloads

## Install

```sh
npm install @core-ds/components
pnpm add @core-ds/components
yarn add @core-ds/components
bun add @core-ds/components
```

## 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.1.5 |
| Published | 2020-08-06 |
| First published | 2019-06-06 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 2.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | andrewpiro, bcooper94, colebemis, danielbeardsley, hackalot805, ianrohde, sterlinghirsh, tgines |

## Links

- npm: https://www.npmjs.com/package/@core-ds/components
- npm.io page: https://npm.io/package/@core-ds/components

## Dependencies (2)

- [@core-ds/icons](https://npm.io/package/@core-ds/icons.md) ^0.6.0
- [@core-ds/primitives](https://npm.io/package/@core-ds/primitives.md) ^0.12.1

## Recent versions

- 0.1.5 (latest) — 2020-08-06
- 0.1.4 — 2020-08-06
- 0.1.1 — 2019-06-06
- 0.1.0 — 2019-06-06

## README

# Core Components

## Docz site

[![Netlify Status](https://api.netlify.com/api/v1/badges/6808ea83-0635-4c9c-95d3-681425ae6672/deploy-status)](https://app.netlify.com/sites/core-design-components/deploys)

https://core-design-components.netlify.com

See existing `.mdx` files for examples on how to document a component.

### Local Docz Server

You can build and serve the docz site locally.

1. Make sure you have the repo cloned and Node installed
2. `npm install`
3. `npm run docz:dev`
4. Any code changes should automatically reload the dev site!

### Configuration

If you need to configure docz, it has a config file located at `doczrc.js.`
Options for netlify are found in `UI/templates/js/netlify.toml`.

### Deployment

Docz is deployed to Netlify automatically on merge to master using the Netlify CLI as part of our continuous integration.
The deploy script is located at `Tests/Exec/deploy-core-components-docz-site.sh`

#### To deploy a draft site:

1. `cd` to the root of the repo in cominor
2. run `Tests/Exec/deploy-core-components-docz-site.sh`
3. Once completed your console should output the "Live Draft URL"

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