Skip to content

Commit a7a5ed4

Browse files
committed
add files for daux
1 parent f631150 commit a7a5ed4

File tree

2 files changed

+270
-0
lines changed

2 files changed

+270
-0
lines changed

docs/config.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"title": "php-classdoc",
3+
"author": "Axel Hahn",
4+
"tagline": "Create a documentation for a php class file",
5+
"ignore": {
6+
"files": ["30_PHP-client/Plugins/Checks/_skeleton.md"],
7+
"folders": ["99_Not_Ready"]
8+
},
9+
"html": {
10+
"auto_toc": true,
11+
"auto_landing": false,
12+
"date_modified": false,
13+
"jump_buttons": true,
14+
"edit_on_github": "axelhahn/php-classdoc/tree/main/docs",
15+
"edit_on_": {
16+
"name": "Gitlab",
17+
"basepath": "https://git-repo.iml.unibe.ch/iml-open-source/__PROJECT__/tree/master/docs"
18+
},
19+
"links": {
20+
"Git Repo": "https://github.com/axelhahn/php-classdoc/",
21+
"Axels Docs": "https://www.axel-hahn.de/docs/"
22+
},
23+
"theme": "daux-blue",
24+
"search": true
25+
}
26+
}

docs/style.css

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,244 @@
1+
/*
2+
3+
patch css elements of daux.io blue theme
4+
version 2024-06-18
5+
6+
*/
7+
8+
:root {
9+
10+
/* Axels Overrides */
11+
--color-text: #567;
12+
--link-color: #37a;
13+
--brand-color: var(--color-secondary);
14+
--brand-background: var(--body-background);
15+
--hr-color: none;
16+
17+
--search-field-background: none;
18+
--search-field-border-color: none;
19+
20+
--sidebar-background:var(--body-background);
21+
--sidebar-border-color: none;
22+
--sidebar-link-active-background: #f8f6f0;
23+
24+
--table-border: #ddd;
25+
--table-header-background: #d8e0e8;
26+
--table-header-background: #d8e8e8;
27+
--table-background-odd: #f8f7f5;
28+
29+
--code-tag-background-color: #f0f4f8;
30+
--code-tag-border-color: rgba(0,0,0,0.05);
31+
32+
/* Axels custom values */
33+
--axel_bg-toc: var(--body-background);
34+
--axel_bg-toc-head: #f8f8f8;
35+
--axel_bg-toc-border: #8ce;
36+
--axel_color-toc:#89a;
37+
38+
--axel_brand-background: none;
39+
--axel_brand-pre-background: #8ce;
40+
--axel_brand-pre-background-hover: #adf;
41+
42+
--axel_h1_header: none;
43+
44+
--axel_h1: #aaa;
45+
--axel_h1-bg: none;
46+
--axel_h1-bottom: 3px solid none;
47+
--axel_h2: #123;
48+
--axel_h2-bg: none;
49+
--axel_h2-bottom: 2px solid #8ce;
50+
--axel_h3: #456;
51+
--axel_h3-bg: none;
52+
--axel_h3-bottom: 1px solid #ddd;
53+
--axel_h4: #8ac;
54+
--axel_h4-bg: none;
55+
--axel_h4-bottom: 1px dashed #ddd;
56+
57+
--axel_hero_bg: #f8f8f8;
58+
59+
--axel_img-border: 2px dashed #cbc;
60+
61+
--axel_nav-bg: #fcfcfc;
62+
--axel_nav-buttomborder: #ddd;
63+
64+
--axel_pre-background: #f8f7f5;
65+
--axel-article-nav-border-top: 0px dotted #ddd;
66+
}
67+
68+
.dark {
69+
70+
/* Axels Overrides */
71+
--color-text: #789;
72+
--link-color: #6bd;
73+
74+
--brand-color: var(--color-text);
75+
--brand-background: var(--body-background);
76+
--hr-color: none;
77+
--code-tag-background-color_: #bcc;
78+
79+
--search-field-background: none;
80+
--search-field-border-color: none;
81+
82+
--sidebar-background:var(--body-background);
83+
--sidebar-border-color: none;
84+
--sidebar-link-active-background: #333;
85+
86+
/* Axels custom values */
87+
--axel_bg-toc: var(--body-background);
88+
--axel_bg-toc-head: #333;
89+
--axel_bg-toc-border: #256;
90+
91+
--axel_brand-background: none;
92+
--axel_brand-pre-background: #69a;
93+
--axel_brand-pre-background-hover: #6ab;
94+
95+
--axel_h1_header: none;
96+
97+
--axel_h1: #777;
98+
--axel_h1-bg: none;
99+
--axel_h1-bottom: none;
100+
--axel_h2: #666;
101+
--axel_h2-bg: #282828;
102+
--axel_h2-bottom: 2px solid #256;
103+
--axel_h3: #838;
104+
--axel_h3: #578;
105+
--axel_h3-bg: none;
106+
--axel_h3-bottom: 1px solid #333;
107+
--axel_h4: #c74;
108+
--axel_h4: #689;
109+
--axel_h4-bg: none;
110+
--axel_h4-bottom: 1px dashed #333;
111+
112+
--axel_hero_bg: #242424;
113+
114+
--axel_img-border: 2px dashed #656;
115+
116+
--axel_nav-bg:#242424;
117+
--axel_nav-buttomborder: #555;
118+
--axel_pre-background: #bcc;
119+
120+
--axel-article-nav-border-top: 0px dotted #234;
121+
}
122+
123+
/* ---------- left side ---------- */
124+
125+
a.Brand::before {
126+
background: var(--axel_brand-pre-background);
127+
border-radius: 100%;
128+
color: #fff;
129+
font-family: arial;
130+
font-weight: bold;
131+
padding: 0.3em 0.3em;
132+
content: 'AH';
133+
margin-right: 0.4em;
134+
float: left;
135+
}
136+
a.Brand:hover::before {
137+
background: var(--axel_brand-pre-background-hover);
138+
}
139+
a.Brand {
140+
background: var(--axel_brand-background );
141+
font-size: 200%;
142+
height: 4em;
143+
}
144+
145+
146+
/* ---------- page header: breadcrumb ---------- */
147+
148+
.Page__header{border: none;}
149+
.Page__header a{color: var(--axel_h1_header);}
150+
.Page__header h1{font-size: 1.3em;}
151+
152+
/* ---------- page content ---------- */
153+
154+
.s-content{padding-top: 1em;}
155+
.s-content h1{background: var(--axel_h1-bg); color: var(--axel_h1); font-size: 200%; font-weight:bold; margin-bottom: 2em; margin-top: 0em; border-bottom: var(--axel_h1-bottom);}
156+
.s-content h2{background: var(--axel_h2-bg); color: var(--axel_h2); font-size: 180%; font-weight:bold; margin-top: 4em; border-bottom: var(--axel_h2-bottom); padding: 0.2em}
157+
h2:first-of-type {margin-top: 0em;}
158+
.s-content>h3{background: var(--axel_h3-bg); color: var(--axel_h3); font-size: 150%; font-weight:bold; margin-top: 5em; border-bottom: var(--axel_h3-bottom);}
159+
.s-content>h4{background: var(--axel_h4-bg); color: var(--axel_h4); font-size: 130%; font-weight:bold; margin-top: 5em; border-bottom: var(--axel_h4-bottom);}
160+
161+
.s-content img{border: var(--axel_img-border); border-radius: 1.5em; padding: 1em; margin: 1em 0;}
162+
.s-content pre{
163+
background: var(--axel_pre-background);
164+
margin: 0 -15px 20px;
165+
padding-left: 15px;
166+
}
167+
168+
/* FIX smaller fnt size in tables */
169+
.s-content table {
170+
font-size: 1em;
171+
}
172+
173+
.s-content h3 code{border: none; background: none; }
174+
175+
article nav{border-top: var(--axel-article-nav-border-top); margin: 8em 0 5em;}
176+
.Pager li > a{padding: 1em 2em;}
177+
178+
.s-content code {
179+
background: var(--code-tag-background-color);
180+
border: 1px solid var(--code-tag-border-color);
181+
}
182+
183+
/* ---------- classes ---------- */
184+
185+
.required{color:#a42;}
186+
.optional{color:#888;}
187+
188+
div.hero{background: var(--axel_hero_bg);border-radius: 2em; padding: 5em 2em;text-align: center;}
189+
div.hero h2{background: none; _border: none; text-align: center; font-size: 300%; margin: 0 0 2em;}
190+
div.hero p.center{text-align: center;}
191+
192+
/* ---------- TOC ---------- */
193+
@media(min-width:1700px){
194+
.TableOfContentsContainer{
195+
position: fixed;
196+
right: 2em;
197+
top: 1em;
198+
}
199+
}
200+
201+
.TableOfContentsContainer{
202+
background-color: var(--axel_bg-toc);
203+
padding: 0.5em;
204+
max-height: 95%;
205+
overflow: auto;
206+
}
207+
208+
.s-content .TableOfContentsContainer h4{
209+
background-color: var(--axel_bg-toc-head);
210+
border-top-left-radius: 0.7em;
211+
border-bottom: 2px solid var(--axel_bg-toc-border);
212+
font-size: 1.2em;
213+
font-weight: bold;
214+
margin: 0;
215+
padding: 0.3em 0.7em;
216+
}
217+
218+
.TableOfContentsContainer__content {
219+
border-width: 1px;
220+
font-size: 0.5em;
221+
}
222+
ul.TableOfContents ul{
223+
list-style-type: none;
224+
padding-left: 1em;
225+
}
226+
ul.TableOfContents a {
227+
color: var(--axel_color-toc);
228+
}
229+
230+
.EditOn a::before{
231+
content: '✏️ ';
232+
}
233+
234+
.Links a[href^="https://github.com/"]::before {
235+
content: '🌐 ';
236+
}
237+
238+
.Links a[href^="https://git-repo.iml.unibe.ch/"]::before {
239+
content: '🌐 ';
240+
}
241+
242+
.Links a[href^="https://www.axel-hahn.de/docs"]::before {
243+
content: '📗 ';
244+
}

0 commit comments

Comments
 (0)