React components for Haddock3 analysis
Components used in the report.html generated by the haddock3-analyse command.
Installation
npm install @i-vresse/haddock3-analysis-components
Usage
See example.html for a simple example which uses the latest library from npm.
See example.local.html for a simple example which uses the library from local dist/
folder.
Should be hosted on a static web server like python3 -m http.server
.
Build
npm run build
Generated dist/
folder.
Publish
Create GitHub release, which will trigger a GitHub action that publishes the package to npmjs.
To publish a pre-release version, create a release with a tag like 1.0.0-next.0
and check the pre-release checkbox.
Development
npm run dev
This will render the ./index.html page with the src/App.tsx component.
Code style
We are using prettier
. To format the code, run:
npm run format