-
Notifications
You must be signed in to change notification settings - Fork 0
/
TechDocTemplate.html
333 lines (289 loc) · 10.5 KB
/
TechDocTemplate.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
<!DOCTYPE html>
<html lang='cs'>
<head>
<title>Tech Documentatin Page Test</title>
<meta charset='utf-8'>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name='description' content=''>
<meta name='keywords' content='Technical Document'>
<meta name='author' content='Pauli'>
<meta name='robots' content='all'>
<!-- <meta http-equiv='X-UA-Compatible' content='IE=edge'> -->
<link href='https://www.shareicon.net/data/256x256/2016/09/09/827545_document_512x512.png' rel='shortcut icon' type='image/png'>
<link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.1/dist/mini-default.min.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css">
</head>
<style>
body {
margin: 0 0 0 0;
padding: 0;
overflow: hidden;
}
/* SCROLL BAR STYLES */
section::-webkit-scrollbar {
width: 0.75em;
}
nav::-webkit-scrollbar {
width: 0.55em;
}
section::-webkit-scrollbar-thumb:horizontal:hover,section::-webkit-scrollbar-thumb:vertical:hover {
background-color: #4a75a5;
border: 1px solid #4a75a5;
}
section::-webkit-scrollbar-thumb:horizontal:active,section::-webkit-scrollbar-thumb:vertical:active {
background-color: #4a75a5;
}
section::-webkit-scrollbar-track, nav::-webkit-scrollbar-track {
box-shadow: inset 0 0 10px rgba(0, 0, 0, 0.3);
}
section::-webkit-scrollbar-thumb, nav::-webkit-scrollbar-thumb {
background-color: #607ea0;
border-radius: 10px;
}
/* SCROLL BAR STYLES END */
section header {
margin: 2em 0 1.5em 0;
border: 1px solid #6681a7a6;
border-radius: 5px;
background-color: #d0dbe9a6;
color: #101010
}
small {
font-style: italic;
}
#mainHeader {
margin: none;
grid-area: header;
background-color:#1565c0;
color: #FFF;
padding-top: 0.5em;
padding-bottom: 1em;
}
#mainContent {
grid-area: main;
background-color: #fff;
margin: 0 3px 0 0;
overflow-y: scroll;
padding: 0 2em 2em 2em;
}
#navbar {
grid-area: nav;
background-color: #fbfdff;
margin: 0;
overflow-y: auto;
overflow-y: scroll;
position: sticky;
}
#mainFooter {
grid-area: foot;
background-color: #062240;
height: 5px;
padding: 2px 10px 10px 10px;
font-size: 0.6rem;
text-align: center;
}
#mainFooter a{
padding-left: 10px;
}
#main-doc {
display: grid;
grid-gap: 20px;
grid-template-columns: minmax(0, 1fr);
grid-template-areas:
"header"
"nav"
"main"
"main"
"main"
"foot";
height: 100vh;
width: 100vw;
}
@media (min-width: 600px) {
#main-doc {
grid-gap: 0px;
grid-template-areas:
"header header"
"nav main"
"nav main"
"foot foot";
grid-template-columns: minmax(200px, 20%) minmax(70%, 80%);
grid-template-rows: auto-fill 1fr 1fr 40px;
}
}
nav header {
color: #1565c0;
margin: 0.1em;
padding: 0.1em;
height: 1.6rem;
text-align: center;
}
nav header h5 {
color: #062240;
margin: 0.1em;
padding: 0.1em;
text-align: center;
}
nav ul {
padding: 0 0 0 8px;
margin: 0;
color: black;
list-style-image:none;
}
nav ul li a, nav ul li {
margin: 3px;
padding: 0.05em;
color: rgb(4, 4, 32)!important;
font-weight: 400;
font-size: 1.0em
}
nav ul li a:hover {
color:rgb(11, 11, 138)!important;
font-weight: 500;
}
.footerText:hover {
text-decoration-style: dotted;
color: #1565c0;
text-decoration: solid dotted white;
};
</style>
</head>
<body>
<main id="main-doc">
<header id="mainHeader">
<h2>Technical documentation page template</h2>
</header>
<nav id="navbar">
<header><h5>Main section</h5></header>
<ul>
<li> <a href="#About_This_Project" class="nav-link">About This Project</a> </li>
<li> <a href="#Main_H3_Section_A" class="nav-link">Main H3 Section A</a> </li>
<li> <a href="#Main_H3_Section_B" class="nav-link">Main H3 Section B</a> </li>
<li> <a href="#Main_H3_Section_C" class="nav-link">Main H3 Section C</a> </li>
<li> <a href="#Main_H3_Section_D" class="nav-link">Main H3 Section D</a> </li>
<li> <a href="#Main_H3_Section_E" class="nav-link">Main H3 Section E</a> </li>
<li> <a href="#Main_H3_Section_F" class="nav-link">Main H3 Section F</a> </li>
</ul>
<header><h5>Next Section</h5></header>
<ul>
<li><a href="#">Item1</a> </li>
<li><a href="#">Item1</a> </li>
<li><a href="#">Item1</a> </li>
</ul>
</nav>
<section id="mainContent">
<section class="main-section" id="About_This_Project">
<header id=">About_This_ProjectH">
<h3>About This Project</h3>
</header>
<h4>Subheader</h4>
<p>This is a simple project for <a href="https://www.freecodecamp.org/paulicz44" target="blank">Freecodecamp's</a> <em>Responsive Web Design Projects</em> certification. With this project and other 4 projects I acquired this certification. In this project I used <a href="https://minicss.org/">minicss</a> css framework (mainly for typography). I used grid-template-areas for layout. All css was coded by me manualy. Layout is made in two versions: mobile and desktop.
</p>
<p>This page can be used as a simple template for technical documentation. This tepmlate can be improved with adding JavaScript for examle for navbar. Maybe i will make it in the future if I have more free time :)</p>
<h4>You can copy this template as you wish and I would be very happy if you cite me as a co-author (or contributor). Thank You.</h4>
</section>
<section class="main-section" id="Main_H3_Section_A">
<header id=">Main_H3_Section_AH">
<h3>Main H3 Section A</h3>
</header>
<h4>Subheader</h4>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamc</p>
</section>
<section class="main-section" id="Main_H3_Section_B">
<header id="Main_H3_Section_BH">
<h3>Main H3 Section B</h3>
</header>
<h4>Subheader</h4>
<p> LoremLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore <code> This == code </code> et dolore magna aliqua.</p>
<pre><link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.1/dist/mini-default.min.css"><br>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"></pre>
<p>This a end of <code>pre</code> paragraph.</p>
</section>
<section class="main-section" id="Main_H3_Section_C">
<header id="Main_H3_Section_CH">
<h3>Main H3 Section C</h3>
</header>
<h4>Subheader</h4>
<p> LoremLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore <code> This == code </code> et dolore magna aliqua.</p>
<pre><link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.1/dist/mini-default.min.css"><br>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"></pre>
<p>This a end of <code>pre</code> paragraph.</p>
</section>
<section class="main-section" id="Main_H3_Section_D">
<header id="Main_H3_Section_DH">
<h3>Main H3 Section D</h3>
</header>
<h4>Subheader</h4>
<p> Example of code: <code> This == code </code>.</p>
<p> This is inception of <code>pre</code> element </p>
<pre><p> LoremLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore <code> This == code </code> et dolore magna aliqua.</p>
<pre>&lt;link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.1/dist/mini-default.min.css"&gt;<br>
&lt;link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"&gt;</pre>
<p>This a end of <code>pre</code> paragraph.</p></pre>
<p>This a end of <code>pre</code> paragraph.</p>
</section>
<section class="main-section" id="Main_H3_Section_E">
<header id="Main_H3_Section_EH">
<h3>Main H3 Section E</h3>
</header>
<h4>Subheader</h4>
<p> LoremLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore <code> This == code </code> et dolore magna aliqua.</p>
<pre><link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.1/dist/mini-default.min.css"><br>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"></pre>
<p>This a end of <code>pre</code> paragraph.</p>
</section>
<section class="main-section" id="Main_H3_Section_F">
<header id="Main_H3_Section_FH">
<h3>Main H3 Section F</h3>
</header>
<h4>Subheader</h4>
<p> LoremLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore <code> This == code </code> et dolore magna aliqua.</p>
<pre><link rel="stylesheet" href="https://cdn.rawgit.com/Chalarangelo/mini.css/v3.0.1/dist/mini-default.min.css"><br>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"></pre>
<p>This a end of <code>pre</code> paragraph.</p>
<h6>List example:</h6>
<ul>
<li>First</li>
<li>Second</li>
<li>Third</li>
<li>Fourth</li>
<li>Fifth</li>
</ul>
</section>
<!-- End of main section -->
</section>
<footer id="mainFooter">
© 2020 Pavel Šťastný <a id="info" class="footerText" href="https://paulicz44.github.io/stastnypavel.github.io/index.html">If you find a bug, please contact me.</a>
<a href="https://www.freecodecamp.org/paulicz44" target="blank" class="footerText"> FCC profile </a>
<a href="https://paulicz44.github.io/stastnypavel.github.io/index.html" target="blank" class="footerText"> My Github</a>
</footer>
</main>
</body>
</html>
<!--
Structure:
//////////////MAIN HEADING////////////////
NAVIGATION Content
[i]CSS │ Content text
//1 │ <h1></h1>
//2 │ <h3></h3>
//3 │ <p></p>
[i]HTML │ <code></code>
//1 │ <p></p>
//2 │ <ul>
//3 │ <li></li>
[i]JS │ <li></li>
//1 │ </ul>
//2 │
//3 │
//button for│
show/hide │
nav bar │
////////////////FOOTER/////////////////////