ci: improve release process, clean up and re-org repo, add automated minification (#143)
* ci: update scripts * release 2.7.1 * remove tracked stylesheets * docs: revert stable tag to 2.7.0 * chore: move Plugin source into own dir * docs: delete info texts These can now be found in the [project wiki][wiki]. [wiki]: https://github.com/markcheret/footnotes/wiki * docs: tweak contributing guide * ci: reflect new directory structure * chore: update gitignore * chore: reflect new dir structure * docs: update documentation * build(linting): add Husky hooks, Markdown linting, lint all MD files * fix pre-push command * fix pre-push command * build: add stylesheet, JS minification * ci: add linting steps * ci: comment out CSS linting step (that's going to be a whole *thing*) * ci: minify all JS files * ci: call correct JS file * chore: lint * ci: fix PHP linting commands * chore: increment version constant string * ci: concat AMP stylesheets * ci: improve build scripts * chore: add assets dir
This commit is contained in:
GitHub
parent
e780d817c1
commit
6a1117be15
183 changed files with 9761 additions and 2941 deletions
112
docs/index.html
112
docs/index.html
|
|
@ -81,42 +81,122 @@
|
|||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Config.html"><abbr title="\MCI_Footnotes_Config">MCI_Footnotes_Config</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Config.html"><abbr title="\Footnotes_Config">Footnotes_Config</abbr></a></dt>
|
||||
<dd>Contains all Plugin Constants. Contains no Method or Property.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Convert.html"><abbr title="\MCI_Footnotes_Convert">MCI_Footnotes_Convert</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Convert.html"><abbr title="\Footnotes_Convert">Footnotes_Convert</abbr></a></dt>
|
||||
<dd>Converts data types and Footnotes specific values.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Init.html"><abbr title="\Footnotes_Layout_Init">Footnotes_Layout_Init</abbr></a></dt>
|
||||
<dd>Handles the Settings interface of the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Engine.html"><abbr title="\MCI_Footnotes_Layout_Engine">MCI_Footnotes_Layout_Engine</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Engine.html"><abbr title="\Footnotes_Layout_Engine">Footnotes_Layout_Engine</abbr></a></dt>
|
||||
<dd>Layout Engine for the administration dashboard.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Layout-Settings.html"><abbr title="\Footnotes_Layout_Settings">Footnotes_Layout_Settings</abbr></a></dt>
|
||||
<dd>Displays and handles all Settings of the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt>
|
||||
<dd>Registers all WordPress Hooks and executes them on demand.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes.html"><abbr title="\MCI_Footnotes">MCI_Footnotes</abbr></a></dt>
|
||||
<dd>Entry point of the Plugin. Loads the Dashboard and executes the Task.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Language.html"><abbr title="\MCI_Footnotes_Language">MCI_Footnotes_Language</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Hooks.html"><abbr title="\Footnotes_Hooks">Footnotes_Hooks</abbr></a></dt>
|
||||
<dd>Registers all WordPress hooks and executes them on demand.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes.html"><abbr title="\Footnotes">Footnotes</abbr></a></dt>
|
||||
<dd>Provides an entry point to the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Language.html"><abbr title="\Footnotes_Language">Footnotes_Language</abbr></a></dt>
|
||||
<dd>Loads text domain of current or default language for localization.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Settings.html"><abbr title="\Footnotes_Settings">Footnotes_Settings</abbr></a></dt>
|
||||
<dd>Loads the settings values, sets to default values if undefined.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Task.html"><abbr title="\Footnotes_Task">Footnotes_Task</abbr></a></dt>
|
||||
<dd>Searches and replaces the footnotes and generates the reference container.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Template.html"><abbr title="\Footnotes_Template">Footnotes_Template</abbr></a></dt>
|
||||
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Widget-Base.html"><abbr title="\Footnotes_Widget_Base">Footnotes_Widget_Base</abbr></a></dt>
|
||||
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Reference-Container.html"><abbr title="\MCI_Footnotes_Widget_Reference_Container">MCI_Footnotes_Widget_Reference_Container</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-Widget-Reference-Container.html"><abbr title="\Footnotes_Widget_Reference_Container">Footnotes_Widget_Reference_Container</abbr></a></dt>
|
||||
<dd>Registers a Widget to put the Reference Container to the widget area.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/Footnotes-WYSIWYG.html"><abbr title="\Footnotes_WYSIWYG">Footnotes_WYSIWYG</abbr></a></dt>
|
||||
<dd>Handles the WSYIWYG-Buttons.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
<h3 id="toc">
|
||||
Table of Contents
|
||||
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_mci_footnotes_require_php_files">mci_footnotes_require_php_files()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
</dt>
|
||||
<dd>Requires (`require_once`) all `*.php` files inside a specific Directory.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<section class="phpdocumentor-functions">
|
||||
<h3 class="phpdocumentor-elements__header" id="functions">
|
||||
Functions
|
||||
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_mci_footnotes_require_php_files">
|
||||
mci_footnotes_require_php_files()
|
||||
<a href="namespaces/default.html#function_mci_footnotes_require_php_files" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/includes.php"><a href="files/src-includes.html"><abbr title="src/includes.php">includes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">17</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Requires (`require_once`) all `*.php` files inside a specific Directory.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">mci_footnotes_require_php_files</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_directory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_str_directory</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"><p>Absolute Directory path to lookup for <code class="prettyprint">*.php</code> files.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
Tags
|
||||
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">author</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.5.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
</section>
|
||||
|
||||
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
||||
<section class="phpdocumentor-search-results__dialog">
|
||||
<header class="phpdocumentor-search-results__header">
|
||||
|
|
|
|||
Reference in a new issue