Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.38 KB

README.md

File metadata and controls

26 lines (17 loc) · 1.38 KB
Raw

Simple TOC Block

A custom WordPress plugin. This plugin is a fork of mtoensing/simpletoc.

Plugin Development

Run composer i to install plugin dependencies. (Normally only needed when not a dependecy of a project.)

  • composer format: Fixes automatic fixes PHP coding standard issues.
  • composer lint: Checks PHP files for coding standard issues.

Block Development

There are several commands to assist you with local development of the plugin.

To install the needed packages, go into the plugin folder and run npm install.

After that, use npm run <command> to run a command. The following commands are available:

  • npm run build: Runs all the JavaScript files in assets/js/src through webpack. The resulting JS files are saved in assets/js/dist.
  • npm run start: Looks for any changes to the JS & CSS files and runs the build command if necessary. Ideal during development when you want to see your changes as quickly as possible in the browser.
  • npm run lint-js: Checks JS files for coding standard issues.
  • npm run lint-js:fix: Fixes automatic fixable JS coding stadard issues.
  • npm run lint-css: Checks JS files for coding standard issues.
  • npm run lint-css:fix: Fixes automatic fixable CSS coding stadard issues.

Browser support for CSS and JavaScript can be adjusted through the browserslist property in package.json.