Rework documentation templates
This commit is contained in:
parent
c4479b4990
commit
102ac855b5
|
@ -6,7 +6,7 @@
|
||||||
{% for version in project.versions %}
|
{% for version in project.versions %}
|
||||||
{% for toc in version.tableOfContents %}
|
{% for toc in version.tableOfContents %}
|
||||||
<section class="phpdocumentor-sidebar__category">
|
<section class="phpdocumentor-sidebar__category">
|
||||||
<h2 class="phpdocumentor-sidebar__category-header">{{ toc.name|capitalize }}</h2>
|
<h2 class="phpdocumentor-sidebar__category-header">{{ toc.name|title }}</h2>
|
||||||
{% for root in toc.roots %}
|
{% for root in toc.roots %}
|
||||||
{{ toc(root, 'components/menu.html.twig', 1) }}
|
{{ toc(root, 'components/menu.html.twig', 1) }}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
|
@ -0,0 +1,19 @@
|
||||||
|
{% for version in project.versions %}
|
||||||
|
{% for toc in version.tableOfContents|filter(toc => toc.name|lower == "documentation" or toc.name|lower == "packages") %}
|
||||||
|
<h4 id="toc-{{ toc.name|lower }}">{{ toc.name|title }}</h4>
|
||||||
|
<dl class="phpdocumentor-table-of-contents">
|
||||||
|
{% for root in toc.roots %}
|
||||||
|
<dt class="phpdocumentor-table-of-contents__entry -{{ toc.name|lower|trim('s', 'right') }}">
|
||||||
|
<a href="{{ root.url }}">{{ root.title|shortFQSEN }}</a>
|
||||||
|
</dt>
|
||||||
|
{% if root.children.count > 0 %}
|
||||||
|
<dd>
|
||||||
|
{% for child in root.children %}
|
||||||
|
<a href="{{ child.url }}">{{ child.title|shortFQSEN }}</a><br/>
|
||||||
|
{% endfor %}
|
||||||
|
</dd>
|
||||||
|
{% endif %}
|
||||||
|
{% endfor %}
|
||||||
|
</dl>
|
||||||
|
{% endfor %}
|
||||||
|
{% endfor %}
|
|
@ -0,0 +1,3 @@
|
||||||
|
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-documentation:before {
|
||||||
|
content: 'D';
|
||||||
|
}
|
|
@ -0,0 +1,24 @@
|
||||||
|
{% extends 'base.html.twig' %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
|
<section>
|
||||||
|
<ul class="phpdocumentor-breadcrumbs">
|
||||||
|
<li><a href>Home</a></li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<h2 class="phpdocumentor-content__title">PHP Basics</h2>
|
||||||
|
|
||||||
|
<p class="phpdocumentor-summary">A collection of generic classes and useful traits for PHP projects.</p>
|
||||||
|
|
||||||
|
<p>The package currently contains classes for <a href="packages/Basics-DataStructures.html">type-sensitive data
|
||||||
|
structures</a>, <a href="packages/Basics-ErrorHandlers.html">error and exception handlers</a>, multiple
|
||||||
|
<a href="packages/Basics-InterfaceTraits.html">traits implementing standard interfaces</a>, and more generic
|
||||||
|
<a href="packages/Basics-Traits.html">traits for common use cases</a>. They share the same design principles like
|
||||||
|
property and method naming schema, highest <a href="https://psalm.dev/">Psalm</a> and <a href="https://phpstan.org/">PHPStan</a> coding standards and full <a href="https://www.php-fig.org/psr/psr-12/">PSR-12</a>
|
||||||
|
compliance to make sure they can be combined and easily re-used in other projects.</p>
|
||||||
|
|
||||||
|
<h3 id="toc">Table of Contents</h3>
|
||||||
|
|
||||||
|
{% include('components/toc.html.twig') %}
|
||||||
|
</section>
|
||||||
|
{% endblock %}
|
Loading…
Reference in New Issue