# redocus

> A tiny static site generator using React and MDX

Latest version **0.3.3** (published 2024-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install redocus
pnpm add redocus
yarn add redocus
bun add redocus
```

Provides the command `redocus`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.3 |
| Published | 2024-02-28 |
| First published | 2023-10-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Josemi Juanes |
| Maintainers | jmjuanes |
| Keywords | static, site, docs, react, mdx |

## Links

- npm: https://www.npmjs.com/package/redocus
- Repository: https://github.com/jmjuanes/redocus
- Homepage: https://github.com/jmjuanes/redocus#readme
- Issues: https://github.com/jmjuanes/redocus/issues
- npm.io page: https://npm.io/package/redocus

## Dependencies (8)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [remark-gfm](https://npm.io/package/remark-gfm.md) ^4.0.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.24.0
- [@mdx-js/mdx](https://npm.io/package/@mdx-js/mdx.md) ^3.0.1
- [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.3
- [@babel/register](https://npm.io/package/@babel/register.md) ^7.23.7
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.23.3

## 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

- 0.3.3 (latest) — 2024-02-28
- 0.3.2 — 2024-02-23
- 0.3.1 — 2024-02-19
- 0.3.0 — 2024-02-18
- 0.2.1 — 2024-02-15
- 0.2.0 — 2024-01-18
- 0.1.1 — 2023-10-08
- 0.1.0 — 2023-10-08
- 0.0.1 — 2023-10-04

## README

# Redocus

![npm version](https://badgen.net/npm/v/redocus?labelColor=1d2734&color=21bf81)
![license](https://badgen.net/github/license/jmjuanes/redocus?labelColor=1d2734&color=21bf81)

> **Redocus** is an experimental package. Its API is not stable and may change without notice. **Use it at your own risk.**

A Node.js tool that enables you to generate static sites using [React](https://react.dev) and [MDX](https://mdxjs.com). It allows you to easily convert `.mdx` files into static HTML pages with the ability to customize the rendering using React components and pass site metadata as props to the pages.

## Installation

You can install the package via npm:

```shell
npm install --save-dev redocus react react-dom @mdx-js/mdx
```

or using yarn:

```shell
yarn add --dev redocus react react-dom @mdx-js/mdx
```

## Usage

Once you have configured your `redocus.config.js` file, you can start generating your static site by running the following command:

```shell
$ redocus --config redocus.config.js
```

You can also add this command to the `scripts` section of your `package.json`:

```json
{
    "name": "my-package",
    "scripts": {
        "build-pages": "redocus --config redocus.config.js"
    }
}
```

This will process the input MDX files, apply the React components and layout, and generate the corresponding HTML files in the output directory.

That's it! You now have a static site generated using React.

## Contributing

Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the [GitHub repository](https://github.com/jmjuanes/redocus).

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

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