web-documentation 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/deploy.js +71 -0
- package/package.json +336 -0
- package/readme.md +37 -0
- package/source/deploy.ts +721 -0
- package/source/dummyDistributionBundle.zip +0 -0
- package/source/dummyReadme.md +266 -0
- package/source/image/arrowDown.png +0 -0
- package/source/image/blacktocat.png +0 -0
- package/source/image/favicon.png +0 -0
- package/source/image/folderBlue.png +0 -0
- package/source/image/folderGray.png +0 -0
- package/source/index.css +492 -0
- package/source/index.html.ejs +303 -0
- package/source/index.ts +431 -0
- package/source/renderMarkdown.mjs +31 -0
- package/source/test.ts +35 -0
- package/source/type.ts +39 -0
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<%_ /*
|
|
3
|
+
region header
|
|
4
|
+
Copyright Torben Sickert (info["~at~"]torben.website) 16.12.2012
|
|
5
|
+
|
|
6
|
+
License
|
|
7
|
+
=======
|
|
8
|
+
|
|
9
|
+
This library written by Torben Sickert stand under a creative commons
|
|
10
|
+
naming 3.0 unported license.
|
|
11
|
+
See https://creativecommons.org/licenses/by/3.0/deed.de
|
|
12
|
+
endregion
|
|
13
|
+
*/
|
|
14
|
+
let START_UP_ANIMATION_NUMBER = 0
|
|
15
|
+
const getStartUpAnimationNumber = () => {
|
|
16
|
+
START_UP_ANIMATION_NUMBER += 1
|
|
17
|
+
return START_UP_ANIMATION_NUMBER
|
|
18
|
+
}
|
|
19
|
+
_%>
|
|
20
|
+
<html class="wu-no-javascript" lang="en">
|
|
21
|
+
<!--region head-->
|
|
22
|
+
<head>
|
|
23
|
+
<meta charset="utf-8">
|
|
24
|
+
<meta
|
|
25
|
+
name="description"
|
|
26
|
+
content="<%- _.TAGLINE.replace(/^(.+?)<!--.+-->$/, '$1').replace("'", "\\'") %>"
|
|
27
|
+
>
|
|
28
|
+
<meta name="author" content="Torben Sickert">
|
|
29
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
30
|
+
<%_ for (const metaTag of _.META_TAGS) { _%>
|
|
31
|
+
<meta <%_ for (const key in metaTag) { _%>
|
|
32
|
+
<%- key %>="<%- metaTag[key] %>"
|
|
33
|
+
<%_ } _%>>
|
|
34
|
+
<%_ } _%>
|
|
35
|
+
<title><%- _.NAME %></title>
|
|
36
|
+
<%- _.include(
|
|
37
|
+
'web-component-wrapper/polyfill.html', {webComponents: false}
|
|
38
|
+
) %>
|
|
39
|
+
<script>
|
|
40
|
+
AUTO_DEFINE_WEB_DOCUMENTATION = true
|
|
41
|
+
|
|
42
|
+
window.document.documentElement.classList.remove('wu-no-javascript')
|
|
43
|
+
window.document.documentElement.classList.add('wu-javascript')
|
|
44
|
+
</script>
|
|
45
|
+
</head>
|
|
46
|
+
<!--endregion-->
|
|
47
|
+
<!--region body-->
|
|
48
|
+
<body class="wu-no-javascript">
|
|
49
|
+
<script>
|
|
50
|
+
window.document.body.classList.remove('wu-no-javascript')
|
|
51
|
+
window.document.body.classList.add('wu-javascript')
|
|
52
|
+
</script>
|
|
53
|
+
|
|
54
|
+
<web-documentation>
|
|
55
|
+
<div class="wu-window-loading-cover">
|
|
56
|
+
<div class="loading-text">
|
|
57
|
+
<lang-replace>
|
|
58
|
+
<span>L</span>
|
|
59
|
+
<span>O</span>
|
|
60
|
+
<span>A</span>
|
|
61
|
+
<span>D</span>
|
|
62
|
+
<span>I</span>
|
|
63
|
+
<span>N</span>
|
|
64
|
+
<span>G</span>
|
|
65
|
+
</lang-replace>
|
|
66
|
+
<!--deDE:
|
|
67
|
+
<span>L</span>
|
|
68
|
+
<span>A</span>
|
|
69
|
+
<span>D</span>
|
|
70
|
+
<span>E</span>
|
|
71
|
+
-->
|
|
72
|
+
<!--frFR:
|
|
73
|
+
<span>C</span>
|
|
74
|
+
<span>H</span>
|
|
75
|
+
<span>A</span>
|
|
76
|
+
<span>r</span>
|
|
77
|
+
<span>g</span>
|
|
78
|
+
<span>e</span>
|
|
79
|
+
<span>m</span>
|
|
80
|
+
<span>e</span>
|
|
81
|
+
<span>n</span>
|
|
82
|
+
<span>t</span>
|
|
83
|
+
-->
|
|
84
|
+
</div>
|
|
85
|
+
</div>
|
|
86
|
+
|
|
87
|
+
<!--region header-->
|
|
88
|
+
<header class="header">
|
|
89
|
+
<div class="header__inner">
|
|
90
|
+
<a
|
|
91
|
+
class="header__inner__forkme-banner wu-start-up-animation-number-<%- getStartUpAnimationNumber() %>"
|
|
92
|
+
href="<%- _.SOURCE_URL %>"
|
|
93
|
+
>
|
|
94
|
+
View on GitHub
|
|
95
|
+
<!--deDE:GitHub-Projekt-->
|
|
96
|
+
<!--frFR:GitHub-Project-->
|
|
97
|
+
<i
|
|
98
|
+
class="header__inner__forkme-banner__icon-github"
|
|
99
|
+
></i>
|
|
100
|
+
</a>
|
|
101
|
+
<h1
|
|
102
|
+
class="header__inner__title wu-start-up-animation-number-<%- getStartUpAnimationNumber() %>"
|
|
103
|
+
><a href="<%- _.URL %>"><%- _.NAME %></a>
|
|
104
|
+
<h2
|
|
105
|
+
class="header__inner__tagline wu-start-up-animation-number-<%- getStartUpAnimationNumber() %>"
|
|
106
|
+
>
|
|
107
|
+
<%- _.TAGLINE %>
|
|
108
|
+
<br />
|
|
109
|
+
</h2>
|
|
110
|
+
<div class="header__inner__links">
|
|
111
|
+
<!--NOTE: These elements are shown in reverse order.-->
|
|
112
|
+
<%_
|
|
113
|
+
let numberOfLanguageLinks = 0
|
|
114
|
+
if (1 < _.LANGUAGES.length) {
|
|
115
|
+
numberOfLanguageLinks = _.LANGUAGES.length
|
|
116
|
+
START_UP_ANIMATION_NUMBER += numberOfLanguageLinks
|
|
117
|
+
}
|
|
118
|
+
if (
|
|
119
|
+
_.API_DOCUMENTATION_PATH &&
|
|
120
|
+
_.IS_DIRECTORY(_.API_DOCUMENTATION_PATH)
|
|
121
|
+
)
|
|
122
|
+
START_UP_ANIMATION_NUMBER += 4
|
|
123
|
+
else
|
|
124
|
+
START_UP_ANIMATION_NUMBER += 2
|
|
125
|
+
START_UP_ANIMATION_NUMBER += 1
|
|
126
|
+
_%>
|
|
127
|
+
<%_ if (_.DISTRIBUTION_BUNDLE_FILE_PATH) { _%>
|
|
128
|
+
<a
|
|
129
|
+
class="header__inner__links__download wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
130
|
+
href="https://github.com/thaibault/<%- _.NAME %>/zipball/main"
|
|
131
|
+
>src.zip</a>
|
|
132
|
+
<%_ START_UP_ANIMATION_NUMBER -= 1 _%>
|
|
133
|
+
<a
|
|
134
|
+
class="header__inner__links__download wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
135
|
+
href="<%- `${_.URL}/${_.DISTRIBUTION_BUNDLE_FILE_PATH}` %>"
|
|
136
|
+
>app.zip</a>
|
|
137
|
+
<%_ } else { _%>
|
|
138
|
+
<a
|
|
139
|
+
class="header__inner__links__download wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
140
|
+
href="https://github.com/thaibault/<%- _.NAME %>/zipball/main"
|
|
141
|
+
>.zip</a>
|
|
142
|
+
<%_ START_UP_ANIMATION_NUMBER -= 1 _%>
|
|
143
|
+
<a
|
|
144
|
+
class="header__inner__links__download wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
145
|
+
href="https://github.com/thaibault/<%- _.NAME %>/tarball/main"
|
|
146
|
+
>.tar.gz</a>
|
|
147
|
+
<%_ }
|
|
148
|
+
START_UP_ANIMATION_NUMBER -= 1 _%>
|
|
149
|
+
<i
|
|
150
|
+
class="header__inner__links__download-arrow wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
151
|
+
></i>
|
|
152
|
+
<%_
|
|
153
|
+
if (numberOfLanguageLinks)
|
|
154
|
+
for (const language of _.LANGUAGES) {
|
|
155
|
+
START_UP_ANIMATION_NUMBER -= 1
|
|
156
|
+
_%>
|
|
157
|
+
<a
|
|
158
|
+
class="header__inner__links__lang tools-hidden-on-javascript-disabled wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
159
|
+
href="#lang-<%- language %>"
|
|
160
|
+
><%- language.slice(0, 2) %></a>
|
|
161
|
+
<%_ }
|
|
162
|
+
if (
|
|
163
|
+
_.API_DOCUMENTATION_PATH &&
|
|
164
|
+
_.IS_DIRECTORY(_.API_DOCUMENTATION_PATH)
|
|
165
|
+
) {
|
|
166
|
+
START_UP_ANIMATION_NUMBER -= 1
|
|
167
|
+
_%>
|
|
168
|
+
<span
|
|
169
|
+
class="header__inner__links__left-arrow icon icon-arrow-left wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
170
|
+
></span>
|
|
171
|
+
<%_ START_UP_ANIMATION_NUMBER -= 1 _%>
|
|
172
|
+
<a
|
|
173
|
+
class="header__inner__links__api-link wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
174
|
+
href="<%- _.URL %>/<%- _.API_DOCUMENTATION_PATH %>"
|
|
175
|
+
>
|
|
176
|
+
<lang-replace>
|
|
177
|
+
API <span>Documentation</span>
|
|
178
|
+
</lang-replace>
|
|
179
|
+
<!--deDE:API<span>-Dokumentation</span>-->
|
|
180
|
+
<!--frFR:<span>Documentation de l'</span>API-->
|
|
181
|
+
</a>
|
|
182
|
+
<%_ START_UP_ANIMATION_NUMBER += 4 + numberOfLanguageLinks
|
|
183
|
+
} else
|
|
184
|
+
START_UP_ANIMATION_NUMBER += 2 + numberOfLanguageLinks
|
|
185
|
+
_%>
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
</header>
|
|
189
|
+
<!--endregion-->
|
|
190
|
+
<!--region sections-->
|
|
191
|
+
<section class="wu-section section">
|
|
192
|
+
<!--region home-->
|
|
193
|
+
<div
|
|
194
|
+
class="section__inner section__home"
|
|
195
|
+
data-website-utilities-section="home"
|
|
196
|
+
>
|
|
197
|
+
<%_
|
|
198
|
+
let content = ''
|
|
199
|
+
if (_.CONTENT && !_.CONTENT.trim().startsWith('<!--html-->'))
|
|
200
|
+
if (_.CONTENT.endsWith('.html'))
|
|
201
|
+
content = _.READ_FILE(_.CONTENT, _.configuration.encoding)
|
|
202
|
+
else if (_.CONTENT.endsWith('.md'))
|
|
203
|
+
content = _.RENDER_MARKDOWN(_.READ_FILE(
|
|
204
|
+
_.CONTENT, _.configuration.encoding
|
|
205
|
+
))
|
|
206
|
+
else
|
|
207
|
+
content = _.RENDER_MARKDOWN(_.CONTENT)
|
|
208
|
+
_%>
|
|
209
|
+
|
|
210
|
+
<%- content %>
|
|
211
|
+
</div>
|
|
212
|
+
<!--endregion-->
|
|
213
|
+
<!--region about this website-->
|
|
214
|
+
<div
|
|
215
|
+
class="section__inner section__about-this-website"
|
|
216
|
+
data-website-utilities-section="about-this-website"
|
|
217
|
+
>
|
|
218
|
+
<h2 id="about-this-website">
|
|
219
|
+
About this website
|
|
220
|
+
<!--deDE:Impressum-->
|
|
221
|
+
<!--frFR:Mentions légales-->
|
|
222
|
+
</h2>
|
|
223
|
+
<p>
|
|
224
|
+
Provider of
|
|
225
|
+
<!--deDE:Anbieter von-->
|
|
226
|
+
<!--frFR:Fournisseur de-->
|
|
227
|
+
<a href="https://torben.website/<%- _.NAME %>">
|
|
228
|
+
https://torben.website/<%- _.NAME %>
|
|
229
|
+
</a>
|
|
230
|
+
:
|
|
231
|
+
<br>
|
|
232
|
+
Torben Sickert
|
|
233
|
+
<br>
|
|
234
|
+
Waldstraße 29
|
|
235
|
+
<br>
|
|
236
|
+
791194 Gundelfingen i.Br.
|
|
237
|
+
<br>
|
|
238
|
+
Phone:
|
|
239
|
+
<!--deDE:Tel.:-->
|
|
240
|
+
<!--frFR:Téléphone:-->
|
|
241
|
+
<a href="tel:004917610248185">
|
|
242
|
+
+49 (0) 176 <span>/</span> 10 248 185
|
|
243
|
+
<br>
|
|
244
|
+
Email:
|
|
245
|
+
<!--deDE:E-Mail:-->
|
|
246
|
+
<a href="mailto:info@torben.website">
|
|
247
|
+
info@torben.website
|
|
248
|
+
</a>
|
|
249
|
+
<br>
|
|
250
|
+
Website:
|
|
251
|
+
<!--deDE:Webseite:-->
|
|
252
|
+
<!--frFR:Site:-->
|
|
253
|
+
<a href="https://torben.website">https://torben.website</a>
|
|
254
|
+
<br>
|
|
255
|
+
<span class="section__inner__arrow-left-home icon icon-arrow-left"></span>
|
|
256
|
+
<a href="#home">
|
|
257
|
+
home
|
|
258
|
+
<!--deDE:Startseite-->
|
|
259
|
+
<!--frFR:Maison-->
|
|
260
|
+
</a>
|
|
261
|
+
</p>
|
|
262
|
+
<%- _.include('legal-notes') %>
|
|
263
|
+
</div>
|
|
264
|
+
<!--endregion-->
|
|
265
|
+
</section>
|
|
266
|
+
<!--endregion-->
|
|
267
|
+
<!--region footer-->
|
|
268
|
+
<footer class="footer">
|
|
269
|
+
<div class="footer__inner">
|
|
270
|
+
<%_ START_UP_ANIMATION_NUMBER += 1 _%>
|
|
271
|
+
<p
|
|
272
|
+
class="wu-start-up-animation-number-<%- START_UP_ANIMATION_NUMBER %>"
|
|
273
|
+
>
|
|
274
|
+
<%- _.NAME %> maintained by
|
|
275
|
+
<!--deDE:<%- _.NAME %> betrieben von-->
|
|
276
|
+
<!--frFR:<%- _.NAME %> exploité par-->
|
|
277
|
+
<%_ /*
|
|
278
|
+
We need an explicit whitespace here preserve whitespaces
|
|
279
|
+
after language switches.
|
|
280
|
+
*/ _%>
|
|
281
|
+
<a href="https://torben.website"> thaibault</a>
|
|
282
|
+
· © 2013 Torben Sickert ·
|
|
283
|
+
<a href="#about-this-website">
|
|
284
|
+
about this website
|
|
285
|
+
<!--deDE:Impressum-->
|
|
286
|
+
<!--frFR:Mentions légales-->
|
|
287
|
+
</a>
|
|
288
|
+
</p>
|
|
289
|
+
</div>
|
|
290
|
+
</footer>
|
|
291
|
+
<!--endregion-->
|
|
292
|
+
<a class="wu-scroll-to-top" href="#top">
|
|
293
|
+
top<!--deDE:nach oben--><!--frFR:ascendant-->
|
|
294
|
+
</a>
|
|
295
|
+
</web-documentation>
|
|
296
|
+
<%_ if (_.configuration.offline) { _%>
|
|
297
|
+
<noscript>
|
|
298
|
+
<iframe src="manifest.html" style="display: none"></iframe>
|
|
299
|
+
</noscript>
|
|
300
|
+
<%_ } _%>
|
|
301
|
+
</body>
|
|
302
|
+
<!--endregion-->
|
|
303
|
+
</html>
|