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 install
in the command line. Or if you need to update some dependencies, runnpm update
Building
-
npm run build
to run build -
npm run watch
to run build and start files watcher -
npm run production
to 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 lint
to showall
lint errors (described below) -
npm run lint-fix
to automatically fix some ofall
linters errors (described below) -
npm run php-lint
to showphpcs
errors -
npm run php-lint-fix
to automatically fix some of thephpcs
errors -
npm run js-lint
to showeslint
errors -
npm run js-lint-fix
to automatically fix some of theeslint
errors -
npm run css-lint
to showstylelint
errors -
npm run css-lint-fix
to automatically fix some of thestylelint
errors
All linters compatible with the modern IDE and code editors.