WARNING: all development is being done in https://github.com/insper-education/active-handout-plugins-py This is not being actively maintained anymore

Active Handout Plugins

If you are not developing a new plugin you probably don't need to worry about this folder.

You can develop plugins using either React (with PropTypes and Styled-Components) or pure JS syntax.

Setup

Run the following commands from the project's root directory:

$ cd plugins-js
$ npm install

Developing plugins

Create and edit your files in the src folder. Then, run the following command from the plugins-js directory to compile and serve the package on localhost:9000:

$ npm run dev

Edit mkdocs to use the package on the development mode:

-   - https://cdn.jsdelivr.net/gh/insper-education/active-handout-plugins-js@main/package/plugin-bundle.js
+   - http://localhost:9000/plugin-bundle.js

Important:

1. When you create a new file, import it on plugin-bundle.js so it gets exported correctly.
2. Before creating a commit, run npm run build to generate a production bundle.
3. Do not add plugin-bundle.js.map