docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-08-09 11:27:33 +01:00
parent fbb00fab2f
commit 8b2f98184d
118 changed files with 59971 additions and 8570 deletions

View file

@ -3,6 +3,7 @@
/* Typography */
--font-primary: 'Source Sans Pro', Helvetica, Arial, sans-serif;
--font-secondary: 'Source Sans Pro', Helvetica, Arial, sans-serif;
--font-monospace: 'Source Code Pro', monospace;
--line-height--primary: 1.6;
--letter-spacing--primary: .05rem;
--text-base-size: 1em;
@ -23,12 +24,13 @@
--primary-color: hsl(96, 57%, 60%);
--primary-color-darken: hsl(96, 57%, 40%);
--primary-color-darker: hsl(96, 57%, 20%);
--primary-color-darkest: hsl(96, 57%, 10%);
--primary-color-lighten: hsl(96, 57%, 80%);
--primary-color-lighter: hsl(96, 57%, 97%);
--primary-color-lighter: hsl(96, 57%, 99%);
--dark-gray: #d1d1d1;
--light-gray: #f0f0f0;
--text-color: #4b3b40;
--text-color: var(--primary-color-darkest);
--header-height: var(--spacing-xxxxl);
--header-bg-color: var(--primary-color);
@ -104,7 +106,6 @@ body {
font-size: var(--text-xxxl);
letter-spacing: var(--letter-spacing--primary);
line-height: 1.25;
margin-top: 0;
}
.phpdocumentor h3 {
@ -166,6 +167,12 @@ body {
.phpdocumentor figure {
margin-bottom: var(--spacing-md);
}
.phpdocumentor figcaption {
text-align: center;
font-style: italic;
font-size: 80%;
}
.phpdocumentor-line {
border-top: 1px solid #E1E1E1;
border-width: 0;
@ -458,11 +465,20 @@ ol.phpdocumentor-list ul.phpdocumentor-list {
li.phpdocumentor-list {
margin-bottom: var(--spacing-md);
}
.phpdocumentor dl dt {
margin-bottom: var(--spacing-xs);
}
.phpdocumentor dl dd {
margin-bottom: var(--spacing-md);
}
.phpdocumentor pre {
margin-bottom: var(--spacing-md);
}
.phpdocumentor-code {
font-family: var(--font-monospace);
background: var(--code-background-color);
border: 1px solid var(--code-border-color);
border-radius: var(--border-radius-base-size);
@ -472,17 +488,26 @@ li.phpdocumentor-list {
box-sizing: border-box;
}
.phpdocumentor-code.-dark {
background: var(--primary-color-darkest);
color: var(--light-gray);
box-shadow: 0 2px 3px var(--dark-gray);
}
pre > .phpdocumentor-code {
display: block;
white-space: pre;
}
.phpdocumentor blockquote {
border-left: 4px solid var(--primary-color);
border-left: 4px solid var(--primary-color-darken);
margin: var(--spacing-md) 0;
padding: var(--spacing-xs) var(--spacing-sm);
color: var(--primary-color-darker);
font-style: italic;
font-size: var(--text-sm);
}
.phpdocumentor blockquote p:last-of-type {
margin-bottom: 0;
}
.phpdocumentor table {
margin-bottom: var(--spacing-md);
@ -685,9 +710,9 @@ td.phpdocumentor-cell:last-child {
}
.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list {
padding-top: var(--spacing-xs);
padding-left: var(--spacing-md);
padding: var(--spacing-xs) var(--spacing-md);
list-style: none;
margin: 0;
}
.phpdocumentor .phpdocumentor-sidebar li {
@ -784,21 +809,26 @@ td.phpdocumentor-cell:last-child {
border-radius: var(--border-radius-base-size);
border-color: var(--primary-color-lighten);
background-color: var(--primary-color-lighter);
font-size: 85%;
padding: .5rem;
margin: 2rem 0;
padding: var(--spacing-lg);
margin: var(--spacing-lg) 0;
display: flex;
flex-direction: row;
align-items: flex-start;
}
.phpdocumentor-admonition--success {
.phpdocumentor-admonition p:last-of-type {
margin-bottom: 0;
}
.phpdocumentor-admonition--success,
.phpdocumentor-admonition.-success {
border-color: var(--admonition-success-color);
}
.phpdocumentor-admonition__icon {
font-size: 2rem;
margin: .75rem 0.75rem 1.25rem 0.5rem;
margin-right: var(--spacing-md);
color: var(--primary-color);
max-width: 3rem;
}
.phpdocumentor ul.phpdocumentor-breadcrumbs {
font-size: var(--text-md);
@ -995,8 +1025,63 @@ td.phpdocumentor-cell:last-child {
border-radius: 3px;
}
}
.phpdocumentor-modal {
position: fixed;
width: 100vw;
height: 100vh;
opacity: 0;
visibility: hidden;
transition: all 0.3s ease;
top: 0;
left: 0;
display: flex;
align-items: center;
justify-content: center;
}
.phpdocumentor-modal__open {
visibility: visible;
opacity: 1;
transition-delay: 0s;
}
.phpdocumentor-modal-bg {
position: absolute;
background: gray;
opacity: 50%;
width: 100%;
height: 100%;
}
.phpdocumentor-modal-container {
border-radius: 1em;
background: #fff;
position: relative;
padding: 2em;
}
.phpdocumentor-modal__close {
position: absolute;
right: 0.75em;
top: 0.75em;
outline: none;
appearance: none;
color: var(--primary-color);
background: none;
border: 0px;
font-weight: bold;
cursor: pointer;
}
/* Used for screen readers and such */
.visually-hidden {
display: none;
}
.float-right {
float: right;
}
.float-left {
float: left;
}

View file

@ -230,7 +230,7 @@ code,
kbd,
pre,
samp {
font-family: monospace, monospace;
font-family: var(--font-monospace);
font-size: 1em;
}

View file

@ -153,6 +153,25 @@
font-size: var(--text-sm);
color: gray;
}
.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source {
flex: 0 1 auto;
display: inline-flex;
}
.phpdocumentor-element-found-in .phpdocumentor-element-found-in__source:after {
width: 1.25rem;
height: 1.25rem;
line-height: 1.25rem;
background: transparent url('data:image/svg+xml;utf8,<svg width="16" height="16" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg" fill="gray"><path d="M5.854 4.854a.5.5 0 1 0-.708-.708l-3.5 3.5a.5.5 0 0 0 0 .708l3.5 3.5a.5.5 0 0 0 .708-.708L2.707 8l3.147-3.146zm4.292 0a.5.5 0 0 1 .708-.708l3.5 3.5a.5.5 0 0 1 0 .708l-3.5 3.5a.5.5 0 0 1-.708-.708L13.293 8l-3.147-3.146z" stroke="gray" stroke-width="1.4"/></svg>') no-repeat center center;
content: '';
left: 0;
border-radius: 50%;
font-weight: 600;
text-align: center;
font-size: .75rem;
margin-top: .2rem;
}
.phpdocumentor-class-graph {
width: 100%; height: 600px; border:1px solid black; overflow: hidden
}