0.6.0 • Published 6 months ago
rapid-react-pkg-demo v0.6.0
🌊 rapid-react-pkg-demo
This is a CLI tool for quickly producing a small react package demo from a README file. It provides simple commands to run a development server and build your Next.js application using react-pkg-demo.
Installation
To install the CLI globally, run:
npm install rapid-react-pkg-demo --save-dev
Usage
Development
Run the Next.js development server.
rapid dev [options]
Build
Build the Next.js application.
rapid build [options]
Options
Option | Default | Description |
---|---|---|
-r, --readme <path> | ./README.md | Path to the README.md file |
-c, --config <path> | ./rapid.config.js | Path to the rapid config file |
Example with options
rapid dev --readme ./docs/README.md --config ./config/rapid.config.js
Rapid Config File
The rapid.config.js
file is used to configure the behavior and appearance of your react package demo. Below is an example configuration:
const Code = require("./src/components/Code");
const { Button } = require("./src");
module.exports = {
color: "#d3c1ad",
packageName: "react-package",
description: "a package react things",
icon: "⏩",
scope: { Button, Code },
};
Configuration Options
Property | Type | Required | Description |
---|---|---|---|
color | string | Yes | The primary color used in the demo. |
packageName | string | Yes | The name of the package. |
description | string | Yes | A short description of the package. |
icon | string | Yes | An icon representing the package. |
scope | object | No | An object containing components to be demoed using react-live. |
License
This project is licensed under the MIT License.
0.6.0
6 months ago
0.5.1
9 months ago
0.5.0
10 months ago
0.4.0
10 months ago
0.3.0
10 months ago
0.2.0
10 months ago
0.1.9
10 months ago
0.1.8
10 months ago
0.1.7
10 months ago
0.1.6
10 months ago
0.1.5
10 months ago
0.1.4
10 months ago
0.1.4-1
10 months ago
0.1.4-0
10 months ago
0.1.3
10 months ago
0.1.2
10 months ago
0.1.1
10 months ago