Skip to content

Commit

Permalink
Improve styling of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-meyer committed Feb 12, 2024
1 parent d358655 commit e002a2e
Show file tree
Hide file tree
Showing 56 changed files with 131 additions and 90 deletions.
31 changes: 0 additions & 31 deletions .phpdoc/template/components/sidebar.html.twig

This file was deleted.

42 changes: 39 additions & 3 deletions .phpdoc/template/css/custom.css.twig
Original file line number Diff line number Diff line change
@@ -1,12 +1,48 @@
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-documentation:before {
content: 'D';
aside.phpdocumentor-sidebar
h2.phpdocumentor-sidebar__category-header
{
text-transform: capitalize;
}

code.prettyprint {
code.prettyprint
{
background-color: var(--code-background-color);
border: 1px solid #f0f0f0;
border-radius: var(--border-radius-base-size);
box-sizing: border-box;
font-size: var(--text-sm);
padding: var(--spacing-xxxs);
}

dl.phpdocumentor-table-of-contents
dt.phpdocumentor-table-of-contents__entry.-documentation:before
{
content: 'D';
}

h2.phpdocumentor-content__title
{
display: flex;
flex-direction: column;
}

h2.phpdocumentor-content__title
div.phpdocumentor-element__package
{
order: 1;
}

h2.phpdocumentor-content__title
span.phpdocumentor-element__extends,
h2.phpdocumentor-content__title
span.phpdocumentor-element__implements
{
font-size: calc(var(--text-xxs) / 1.2 / 1.2);
order: 2;
}

h2.phpdocumentor-content__title
span:first-letter
{
text-transform: lowercase;
}
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-DataStructures-StrictList.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-DataStructures-StrictQueue.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-DataStructures-StrictStack.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Interfaces-ArrayAccessTrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Interfaces-CountableTrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Interfaces-IteratorTrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Traits-Getter.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Traits-OverloadingGetter.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Traits-OverloadingSetter.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Traits-Setter.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/classes/OCC-Basics-Traits-Singleton.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
42 changes: 39 additions & 3 deletions doc/css/template.css
Original file line number Diff line number Diff line change
Expand Up @@ -269,15 +269,51 @@
.phpdocumentor-tag-link {
margin-right: var(--spacing-sm);
}
.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry.-documentation:before {
content: 'D';
aside.phpdocumentor-sidebar
h2.phpdocumentor-sidebar__category-header
{
text-transform: capitalize;
}

code.prettyprint {
code.prettyprint
{
background-color: var(--code-background-color);
border: 1px solid #f0f0f0;
border-radius: var(--border-radius-base-size);
box-sizing: border-box;
font-size: var(--text-sm);
padding: var(--spacing-xxxs);
}

dl.phpdocumentor-table-of-contents
dt.phpdocumentor-table-of-contents__entry.-documentation:before
{
content: 'D';
}

h2.phpdocumentor-content__title
{
display: flex;
flex-direction: column;
}

h2.phpdocumentor-content__title
div.phpdocumentor-element__package
{
order: 1;
}

h2.phpdocumentor-content__title
span.phpdocumentor-element__extends,
h2.phpdocumentor-content__title
span.phpdocumentor-element__implements
{
font-size: calc(var(--text-xxs) / 1.2 / 1.2);
order: 2;
}

h2.phpdocumentor-content__title
span:first-letter
{
text-transform: lowercase;
}
2 changes: 1 addition & 1 deletion doc/files/src-datastructures-strictcollection.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-datastructures-strictlist.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-datastructures-strictqueue.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-datastructures-strictstack.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-errorhandlers-throwerrorexception.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-errorhandlers-triggerexceptionerror.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-interfaces-arrayaccesstrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-interfaces-countabletrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-interfaces-iteratoraggregatetrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-interfaces-iteratortrait.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-traits-getter.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
2 changes: 1 addition & 1 deletion doc/files/src-traits-overloadinggetter.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">PHP
</label>
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Documentation</h2>
<h2 class="phpdocumentor-sidebar__category-header">documentation</h2>
<h4 class="phpdocumentor-sidebar__root-namespace">
<a href="guides/installation/index.html#installation" class="">Installation</a>
</h4>
Expand Down
Loading

0 comments on commit e002a2e

Please sign in to comment.