wp-handbook-converter

Description

Convert all pages in a specific type of WordPress handbook into markdown files.

Install

$ npm i -g wp-handbook-converter

If you want to run the command without installing the package, use this: $ npx wp-handbook-converter

wp-handbook-converter command options

• -t, --team <team> Specify team name.
• -b, --handbook <handbook> Specify handbook name. (Default "handbook")
• -s, --sub-domain <sub-domain> Specify subdomain name. e.g. "developer" for developer.w.org, "w.org" for w.org (Default "make")
• -o, --output-dir <output-dir> Specify the directory to save files (default en/)
• -r, --regenerate <regenerate> If this option is supplied, the directory you specified as output directory will once deleted, and it will regenerate all the files in the directory

Example

Get Core Contributor Handbook

$ wp-handbook-converter --team core

Get Meetup Organizer Handbook

$ wp-handbook-converter --team community --handbook meetup-handbook

Get theme Handbook

$ wp-handbook-converter --handbook theme-handbook --sub-domain developer

Get plugin Handbook

$ wp-handbook-converter --handbook plugin-handbook --sub-domain developer

Development

Linting

This project uses Prettier for code formatting. You can check for linting errors by running:

npm run lint

You can automatically fix linting errors by running:

npm run lint:fix