Important: to get the submodule of Turf going, you'll need to clone this repository with
the --recursive flag.
Changes to the API documentation happen upstream in the actual Turf repository. For example if you wanted to update the buffer documentation you would go to the @turf/buffer/index.js and edit jsdocs.
Presuming you've updated the documentation in the relevant turf module and your changes have been accepted, you can now update the docs using the following procedure:
- Start with updating the turf project dependency:
cdinto the turf-www/turf submodule andgit pull origin master cdback to the root of the turf-www project- Run
npm run generate - Commit and push the changes
If you would like to have a go at updating the actual website then you'll need to make changes in the src folder. The pages are built using Vue.js and Nuxt.js.
To get a server running with live-reload etc so you can work on the docs run npm run start.