docspress
docspress copied to clipboard
WordPress online documentation engine
DocsPress - online documentation engine
- WordPress Plugin https://wordpress.org/plugins/docspress/
Development
Requirements
| Prerequisite | How to check | How to install |
|---|---|---|
| PHP >= 5.5.9 | php -v |
php.net |
| Node.js >= 6.x.x | node -v |
nodejs.org |
| Composer >= 1.0.0 | composer -V |
getcomposer.org |
Installation
- Run
npm installin the command line. Or if you need to update some dependencies, runnpm update
Building
npm run buildto run buildnpm run watchto run build and start files watchernpm run productionto run build and prepare zip files for production
Linting
We use pre-commit and pre-push hooks for Git to lint sources with phpcs, eslint and stylelint tasks.
NPM commands to work with linting:
npm run lintto showalllint errors (described below)npm run lint-fixto automatically fix some ofalllinters errors (described below)npm run php-lintto showphpcserrorsnpm run php-lint-fixto automatically fix some of thephpcserrorsnpm run js-lintto showeslinterrorsnpm run js-lint-fixto automatically fix some of theeslinterrorsnpm run css-lintto showstylelinterrorsnpm run css-lint-fixto automatically fix some of thestylelinterrors
All linters compatible with the modern IDE and code editors.