# @papyrum/cli

> > TODO: description

Latest version **1.0.15** (published 2022-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @papyrum/cli
pnpm add @papyrum/cli
yarn add @papyrum/cli
bun add @papyrum/cli
```

Provides the command `papyrum`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.15 |
| Published | 2022-07-25 |
| First published | 2019-07-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 96.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 21 |
| Author | wilsson |
| Maintainers | wilsson |
| Keywords | documentation, react |

## Links

- npm: https://www.npmjs.com/package/@papyrum/cli
- Repository: https://github.com/wilsson/papyrum
- Homepage: https://github.com/wilsson/papyrum#readme
- Issues: https://github.com/wilsson/papyrum/issues
- npm.io page: https://npm.io/package/@papyrum/cli

## Dependencies (17)

- [react](https://npm.io/package/react.md) 16.13.0
- [yargs](https://npm.io/package/yargs.md) 13.2.1
- [fs-extra](https://npm.io/package/fs-extra.md) 8.1.0
- [inquirer](https://npm.io/package/inquirer.md) 7.0.1
- [deepmerge](https://npm.io/package/deepmerge.md) 4.2.2
- [react-dom](https://npm.io/package/react-dom.md) 16.13.0
- [@papyrum/ui](https://npm.io/package/@papyrum/ui.md) ^1.0.15
- [react-redux](https://npm.io/package/react-redux.md) 7.1.3
- [react-helmet](https://npm.io/package/react-helmet.md) 5.2.1
- [@mdx-js/react](https://npm.io/package/@mdx-js/react.md) 1.5.0
- [@papyrum/core](https://npm.io/package/@papyrum/core.md) ^1.0.15
- [humanize-string](https://npm.io/package/humanize-string.md) 2.1.0
- [@papyrum/ui-docs](https://npm.io/package/@papyrum/ui-docs.md) ^1.0.15
- [react-router-dom](https://npm.io/package/react-router-dom.md) 5.0.0
- [styled-components](https://npm.io/package/styled-components.md) 4.3.2
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) 0.9.1
- [validate-npm-package-name](https://npm.io/package/validate-npm-package-name.md) 3.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.15 (latest) — 2022-07-25
- 1.0.14 — 2022-07-25
- 1.0.13 — 2022-07-25
- 1.0.12 — 2022-07-25
- 1.0.11 — 2022-07-24
- 1.0.10 — 2022-03-12
- 1.0.9 — 2022-03-11
- 1.0.8 — 2022-03-11
- 1.0.6 — 2021-02-07
- 1.0.5 — 2021-02-06
- 1.0.4 — 2021-02-06
- 1.0.3 — 2020-08-25
- 1.0.2 — 2020-08-24
- 1.0.1 — 2020-03-06
- 1.0.0 — 2020-03-06
- … 24 more at https://npm.io/package/@papyrum/cli/versions

## README

<p align="center">
  <img src="https://user-images.githubusercontent.com/4754339/71502967-1a73bf80-2841-11ea-9add-13cd5bd905dd.png" />
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/@papyrum/cli" target="_blank">
    <img src="https://badgen.net/npm/v/@papyrum/cli" alt="">
  </a>
  <a href="https://www.npmjs.com/package/@papyrum/cli" target="_blank">
    <img src="https://badgen.net/npm/dt/@papyrum/cli" alt="">
  </a>
  <a href="LICENSE" target="_blank">
    <img src="https://badgen.net/npm/license/@papyrum/cli" alt="">
  </a>
</p>

[Papyrum](https://papyrum.site/) is a tool that will help you document your design system or library of components based on [React](https://reactjs.org/).

## Features

- Zero config
- [MDX based](https://mdxjs.com/), builds documentation with the markdown of the component era.
- Typescript support
- Syntax highlighting with [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer).

<p align="center">
  <img src="https://user-images.githubusercontent.com/4754339/91013125-d80ba980-e5ac-11ea-805d-0361ece616cd.png" />
</p>

## Start a new project

Papyrum brings with it a command that will help you build your project based on templates.

```bash
npx @papyrum/cli new [name] [template]
```

For example:

```bash
npx @papyrum/cli new my-website basic

```

| Template | Description |
| ------------- | ------------- |
| `basic` | Basic template |
| `typescript` | Basic template with typescript |

### Project structure

```
my-website
├── docs
│   ├── Introduction.mdx
│   └── Button.mdx
├── src
│   └── components
├── static
│   └── img
│       ├── favicon.ico
│       └── logo.svg
├── package.json
├── .editorconfig
├── papyrum.config.js
└── yarn.lock
```

### Structure summary

- `docs` : Folder where our `.mdx` documentation files are hosted.
- `src` : Ffolder where the components to be built are stored, in the case of building a component library.
- `static` : Default place where static files will be served.
- `papyrum.config.js` : Papyrum settings.

Now execute this command to be able to raise a development server that will listen to your changes as you develop.

```
yarn dev
```

or

```
npm run dev
```

## Add Papyrum to an existing project

You just need to install the command line tool:

```
yarn add @papyrum/cli
```

or

```
npm install @papyrum/cli
```

Then create an `.mdx` file:

```
---
route: /
name: Hello world
---

# Hi!
___

Hello world with mdx
```

Finally run:

```
yarn dev
```

or

```
npm run dev
```

## Examples

- [Basic](https://github.com/wilsson/papyrum/tree/master/examples/basic)
- [With typescript](https://github.com/wilsson/papyrum/tree/master/examples/typescript)

If you have any suggestion of a feature or feedback please do not hesitate to create a [issue](https://github.com/wilsson/papyrum/issues).

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