rJS Plugin Template

A basic plugin structure to develop an isolated, reusable rJS plugin.

Visit https://rapidjs.org for more information.

Recommended README structure below:

TODO: Brief description

rJS Plugin:

Install

npm i <PACKAGE-REFERENCE>

_{__rjs.plugin.json}

{
  "package": "<PACKAGE-REFERENCE>"
}

Use

TODO: Usage description

└─ /src …
   └─ /<PLUGIN-NAME>
      ├─ __rjs.plugin.json
      ├─ /components
      │  ├─ _button.scss
      │  ├─ _header.scss
      │  └─ _footer.scss
      └─ /pages
         ├─ index.html
         └─ rates.html

Configure

TODO: Configuration description

_{__rjs.plugin.json}

{
  "package": "<PACKAGE-REFERENCE>",
  "config": {

  }
}