https://github.com/jmjuanes/redocus

:memo: Tiny static site generator for React and MDX
https://github.com/jmjuanes/redocus

cli docs-generator documentation-generator markdown mdx mdx-js react static-site static-site-generator

Last synced: about 2 months ago
JSON representation

:memo: Tiny static site generator for React and MDX

• Host: GitHub
• URL: https://github.com/jmjuanes/redocus
• Owner: jmjuanes
• License: mit
• Archived: true
• Created: 2023-10-04T18:09:06.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-28T18:04:38.000Z (9 months ago)
• Last Synced: 2024-09-21T09:02:28.958Z (2 months ago)
• Topics: cli, docs-generator, documentation-generator, markdown, mdx, mdx-js, react, static-site, static-site-generator
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/redocus
• Size: 44.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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.