Chromium Screenshot

Status

Documentation

Package documentation is deployed to GitLab Pages.

Dependencies

This package requires Node.js 8.x or later; modules required by the package are documented in the package.json file.

Code Quality

To run the unit tests and generate a coverage report in /coverage with Mocha and Istanbul run npm install followed by npm test at the command line.

To run ESLint run npm install followed by npm run lint at the command line.

Generating documentation

Generating the docs requires Python to be installed, tested with v3.12. With the Python binary in the path, run, install MkDocs if not present:

➜  mkdir venv               
➜  python -m venv venv 
➜  source venv/bin/activate
➜  which python
/path/to/venv/bin/python
➜  python -V
Python 3.12.3
➜  pip install mkdocs mkdocs-material

Then to generate the docs run:

➜  npm i
➜  npm run docs

to generate static files in ./site.