footnotes aims to be the all-in-one solution for displaying an automatically-generated list of references on your Page or Post. The Plugin ships with a set of defaults while also empowering you to control how your footnotes will be displayed.
footnotes gives you the ability to display well-formatted footnotes on your WordPress Pages and Posts — those footnotes we know from offline publishing.
Featured on wpmudev — cheers for the review, folks!
This Plugin provides:
git clone git@github.com:markcheret/footnotes.git
):
composer install
):
php-mbstring
manually if you do not already
have it.Automated release deployments will be introduced soon.
_tools/build-stylesheets.sh -c
to concatenate stylesheets;css/tmp/
, saving them as .min.css
files:
build
command._tools/build-stylesheets.sh -d
to deploy the minified files to dist/
:
dist/
folder!composer run build
to move over the remaining files to dist/
:
_tools/build.sh
; but.distignore
filecomposer run release
and follow the prompts.Automated testing will be introduced soon.
This repo. uses pre-commit code formatting and linting on all staged files. This ensures that only style-conformant code can be committed.
The individual commands can also be called manually:
Run composer run format
to run all format commands.
Run composer run format:fix
to attempt to automatically fix all formatter warnings
and errors.
Run composer run lint
to run all linting commands.
Run composer run lint:fix
to attempt to automatically fix all linter warnings
and errors.
PHP code must follow the WordPress PHP Coding Standards.
composer run lint:php
to lint all JS/TS files with PHP CodeSniffercomposer run lint:php:fix
to attempt to automatically fix warnings and
errors with the PHP Code Beautifier and Formatter.JavaScript code must follow the WordPress JavaScript Coding Standards.
Run composer run format:js
to format all JS files with Prettier.
Run composer run format:js:fix
to attempt to automatically fix warnings and errors.
Run composer run lint:js
to lint all JS files with ESLint.
Run composer run lint:js:fix
to attempt to automatically fix warnings and errors.
Prettier configuration settings are found in .prettierrc
.
ESLint configuration settings are found in .eslintrc.js
. File ignore rules are
found in .eslintignore
.
JavaScript code must follow the WordPress CSS Coding Standards.
composer run lint:css
to format all CSS files with stylelint.npcomposerm run lint:css:fix
to attempt to automatically fix warnings and
errors.stylelint configuration settings are found in .stylelint.json
.
Run composer run docs
to automatically generate HTML documentation with
phpDocumentor.
View the current docs here.
Huge thanks to every footnotes user, contributor, bug reporter, feature requester and fan!
This project is licensed under the GNU GPL v3.
Name | Link(s) |
---|---|
Mark Cheret |