drafting

Contributing

Before contributing to chart.xkcd you'll need a few things:

• install npm

Setup

# install dependencies
npm i

# start examples
npm start

Then you can open localhost:1234 to see the examples, and you can start to edit the code. Thanks to parcel, the website will be auto updated when you make changes.

Layout

• docs: Documentation used to generate timqian.com/chart.xkcd
  • preview docs: npm run genDoc and npx serve
• examples: Examples showing how to use chart.xkcd. The npm example is also used for developing and debug features for now.
• src: where the meat locates

Releases

To release a new version, just update the version number in package.json. New version will be released by github actions.