Improve new 'default' template

[mvriel]

I have created this issue to track and write down my progress on the new 'default' template. This description will change with every iteration and will reflect the latest finds and points of improvement.

TODO:

• Table of Contents, and the method/property/constant listing, is not sorted by visibility and alphabet
• Change the grid's selectors to match the CSS standards
• Document the shit out of the new template and specifically: how to surgically alter it to your needs
• Describe the CSS standards for future contributors
• Test
• When an element overrides an inherited version, add a link to the inherited version in the element's description
• I think I saw a tag header shown, even though there are no tags; check this
• check source code inclusion, references and styling
• Research pushing NPM package with CSS, see https://help.github.com/en/actions/language-and-framework-guides/publishing-nodejs-packages
• Write tests for changes in the Extension class

[jrfnl]

Some small things which I noticed in the template:

Markdown table layout off

Minimal code sample:

    /**
     * Summary.
     *
     * Unkeyed arrays | Keyed arrays
     * -------------- | ------------
     * processNoKey() | processKey()
     * -              | processArrow()
     * processValue() | processValue()
     * processComma() | processComma()
     */
    function foo() {}

Originally found in: https://github.com/PHPCSStandards/PHPCSUtils/blob/7a54196a2c079dae38d2bd5b5eb605f514d9c3e6/PHPCSUtils/AbstractSniffs/AbstractArrayDeclarationSniff.php#L209-L233

Result:

[jrfnl]

Some small things which I noticed in the template:

Inline code with non-code in between loses spacing

Minimal code sample:

    /**
     * Summary.
     *
     * - References to class properties with `self::`, `parent::`, `static::`,
     *  `namespace\ClassName::`, `classname::` were not recognized as references.
     */
    function foo() {}

Originally found in: https://github.com/PHPCSStandards/PHPCSUtils/blob/7a54196a2c079dae38d2bd5b5eb605f514d9c3e6/PHPCSUtils/BackCompat/BCFile.php#L963-L991

Result:

[jrfnl]

Some small things which I noticed in the template:

The "Project name" doesn't link to the docs index.html file

... which means that once you've left the index.html file, there is no way to get back to it anymore as there is no link to it anywhere.

[mvriel]

👍 Thanks!