Development Guide

1. git clone

git clone https://github.com/kohheepeace/mr-pdf.git

2. Change git branch and commit

Change branch and commit

git checkout -b hot-fix

...
implement new feature, fix a bug, etc...
...

git commit -m "YOUR_NEW_COMMIT_MESSAGE"

3. Build and Run mr-pdf

• yarn build commands generate lib folder.
• node lib/cli.js command is equivalent to mr-pdf in development.

Test if mr-pdf works in your development environment by executing the command below.

yarn build
node lib/cli.js TYPE_HERE_YOUR_COMMAND

For example,

node lib/cli.js --initialDocURLs="https://docusaurus.io/docs/" --contentSelector="article" --paginationSelector="a.pagination-nav__link--next" --excludeSelectors=".theme-doc-breadcrumbs,a.theme-edit-this-page" --coverImage="https://docusaurus.io/img/docusaurus.png" --coverTitle="Docusaurus v2"

Push your commit

git push origin hot-fix

Then, go to https://github.com/kohheepeace/mr-pdf and Request PR.

Refs

• https://github.com/kohheepeace/hello-ts-cli