-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy path_config.yml
537 lines (502 loc) · 16.1 KB
/
_config.yml
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
# ---------
# JEKYLL CONFIGURATION
# More info at https://jekyllrb.com/docs/configuration/options/
# ---------
# TO USE JEKYLL LIBDOC AS REMOTE THEME, UNCOMMENT (available only on Github)
remote_theme: olivier3lanc/Jekyll-LibDoc
title: Jekyll LibDoc as remote theme
description: >- # Description of the docs. (>- means to ignore newlines until next param)
An example of a repository using Jekyll LibDoc as a remote theme
# IMPORTANT: on Github Pages deploys, url and baseurl must be commented or set to proper settings, otherwise links and resources URL are wrong
# url: http://localhost # the base hostname & protocol for your site, e.g. http://example.com
# baseurl: /Jekyll-LibDoc/_site # the subpath of your site, e.g. /blog
#permalink: /:path/:basename/:output_ext
#destination: ../your/new/path # Build relative path destination. The destination directory e.g. /blog
#keep_files: [cache]
#markdown: kramdown
defaults:
-
values:
layout: libdoc/page
kramdown:
syntax_highlighter_opts:
disable: true
sass:
style: compressed
#exclude: ['/misc']
# ---------
# LIBDOC CONFIGURATION
# https://olivier3lanc.github.io/Jekyll-LibDoc/libdoc-config.html
# ---------
# PLAYGROUND
# The user context entirely separated from LibDoc theme
playground:
# PLAYGROUND STYLESHEETS
# Style sheets in <head>. Can be either:
# Relative URL from site root starting with slash /
# Absolute URL starting with 'http'
stylesheets:
- /demo-only/css/normalize.css
# - /demo-only/css/photoswipe.css
# PLAYGROUND HEAD JAVASCRIPTS
# Javascript in <head>. Can be either:
# Relative URL from site root starting with slash /
# Absolute URL starting with 'http'
scripts_head:
# - /assets/libdoc/js/my-toggles.js
# PLAYGROUND MODULES JAVASCRIPTS
# Javascript type="module" are set before text/javascript files
# JS modules do not work with a file:// URL
# JS modules need a web server.
scripts_body_modules:
# - /demo-only/js/demo.js
# PLAYGROUND BODY JAVASCRIPTS
# Javascript type="text/javascript" near </body>. Can be either:
# Relative URL from site root starting with slash /
# Absolute URL starting with 'http'
scripts_body: # Javascript files near </body>. Can be either relative URL from site root, absolute URL starting with 'http'
- /demo-only/js/ola.min.js
- /demo-only/js/scroll-btween.js
# - https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js
# - /demo-only/js/demo.js
# PLAYGROUND MINIMUM HEIGHT
# Sets a minimum height for each playground, default is 300px
min_height: 300px
# PLAYGROUND METADATA
# Metadata for the playground only
metadata:
# PLAYGROUND LANGUAGE
# Change the language of the playground, default is en
lang: en
# PLAYGROUND CACHE
# Enable or not browser cache for the playground
cache: false
# PLAYGROUND PNG favicon file
# Path from root or absolute/remote URL - Square 32x32 pixels icon png format or .ico for old browsers
favicon: /assets/libdoc/img/favicon/playground-android-chrome-512x512.png
# PLAYGROUND SVG favicon example - NOT supported on Safari
# favicon: data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 width=%22256%22 height=%22256%22 viewBox=%220 0 100 100%22><rect width=%22100%22 height=%22100%22 rx=%2220%22 fill=%22%237d6ee7%22></rect><path fill=%22%23fff%22 d=%22M36.63 22.42L66.52 22.42Q66.78 22.87 67.06 23.63Q67.32 24.40 67.32 25.30L67.32 25.30Q67.32 26.83 66.60 27.73Q65.88 28.63 64.53 28.63L64.53 28.63L40.05 28.63L40.05 47.35L63.36 47.35Q63.63 47.80 63.91 48.56Q64.17 49.33 64.17 50.23L64.17 50.23Q64.17 51.76 63.45 52.66Q62.73 53.56 61.38 53.56L61.38 53.56L40.05 53.56L40.05 77.05Q39.60 77.23 38.66 77.41Q37.71 77.59 36.72 77.59L36.72 77.59Q32.67 77.59 32.67 74.34L32.67 74.34L32.67 26.38Q32.67 24.58 33.75 23.50Q34.84 22.42 36.63 22.42L36.63 22.42Z%22></path></svg>
# PLAYGROUND AUTOMATIC FAVICON
# Automatic generation of multiple PNG favicons URL. Generates proper favicon files sizes for multiple devices. Must be an absolute URL starting with 'http'
# favicon_auto must be a public URL image file with a minimum 192x192 pixels
# favicon_auto: https://i.ibb.co/cNmfL3D/android-chrome-512x512.png
# PLAYGROUND AUTHOR NAME
# Sets the name of the author for the playground. Default is empty.
author:
# PLAYGROUND THEME COLOR
# Theme color metadata used in some browsers like Chrome that applies this color on browser address bar.
# Color must be in HEX, default is LibDoc's color
color: '#556e1e'
# PLAYGROUND IMAGE
# Open Graph image file for social networks. Can be either relative URL from site root, absolute URL starting with 'http'. Default is LibDoc's splash screen.
# image: /img/custom_image.webp
image: /assets/libdoc/img/meta-image-playground.jpg
# METADATA
# Metadata informations for the site/project
metadata:
# LANGUAGE
# Change the language of the playground, default is en
lang: en
# CACHE
# Enable or not browser cache for the playground
cache: false
# PNG favicon file
# Path from root or absolute/remote URL - Square 32x32 pixels icon png format or .ico for old browsers
favicon: /assets/libdoc/img/favicon/favicon-32x32.png
# SVG favicon example - NOT supported on Safari
# favicon: data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 width=%22256%22 height=%22256%22 viewBox=%220 0 100 100%22><rect width=%22100%22 height=%22100%22 rx=%2220%22 fill=%22%237d6ee7%22></rect><path fill=%22%23fff%22 d=%22M36.63 22.42L66.52 22.42Q66.78 22.87 67.06 23.63Q67.32 24.40 67.32 25.30L67.32 25.30Q67.32 26.83 66.60 27.73Q65.88 28.63 64.53 28.63L64.53 28.63L40.05 28.63L40.05 47.35L63.36 47.35Q63.63 47.80 63.91 48.56Q64.17 49.33 64.17 50.23L64.17 50.23Q64.17 51.76 63.45 52.66Q62.73 53.56 61.38 53.56L61.38 53.56L40.05 53.56L40.05 77.05Q39.60 77.23 38.66 77.41Q37.71 77.59 36.72 77.59L36.72 77.59Q32.67 77.59 32.67 74.34L32.67 74.34L32.67 26.38Q32.67 24.58 33.75 23.50Q34.84 22.42 36.63 22.42L36.63 22.42Z%22></path></svg>
# AUTOMATIC FAVICON
# Automatic generation of multiple PNG favicons URL. Generates proper favicon files sizes for multiple devices. Must be an absolute URL starting with 'http'
# favicon_auto must be a public URL image file with a minimum 192x192 pixels
# favicon_auto: https://i.ibb.co/cNmfL3D/android-chrome-512x512.png
# AUTHOR NAME
# Name of the author of the site/project, used into various places of the theme like footer. Default is empty
author:
# THEME COLOR
# Theme color metadata used in some browsers like Chrome that applies this color on browser address bar.
# Color must be in HEX, default is LibDoc's color
color: '#123456'
# IMAGE
# Open Graph image file for social networks. Can be either relative URL from site root, absolute URL starting with 'http'. Default is LibDoc's splash screen.
# image: /img/custom_image.webp
image: /assets/libdoc/img/libdoc.png
# SIDEBAR
# Main navigation containing site/project's logo, pages links and search form.
sidebar:
# SEARCH FEATURE
# Enable or disable search feature
disable_search: false
# LOGO
# Top left branding/homepage link, specified image URL or site title if no URL is set
logo:
# LOGO URL
# Image URL: Can be local e.g. '/img/logo.png' or remote 'https://remotesite.com/img/logo.png'
url: /assets/libdoc/img/favicon/android-chrome-512x512.png
# LOGO MAX HEIGHT
# Logo image max height, applies only if url is set
max_height: 40px
# LOGO FONT SIZE FALLBACK
# If no logo url, font size of the site title, ignored if url is set
font_size: 32px
# ADDITIONAL LINKS
# Allows to add links that are not pages included into the project
# Display additional links anywhere into the sidebar
additional_links:
- url: https://github.com/olivier3lanc/LibDoc-remote-demo # Local or remote URL
title: <span class="i-github u-mr-xxs"></span> View on GitHub # Link text
order: 0 # Sets the rank of the page link into the sidebar, higher values give lower rank for the page link
# category: Showcase # Add this this link into a category just like pages
# - url: https://www.youtube.com/embed/iWowJBRMtpc # Local or remote URL
# title: Iframe mode example # Link text
# order: 100 # Sets the rank of the page link into the sidebar, higher values give lower rank for the page link
# iframe_mode: true
# category: Features
# Example URL
- url: https://olivier3lanc.github.io/Scroll-Btween/
title: Scroll Btween
order: 500
category: Examples using LibDoc
- url: https://olivier3lanc.github.io/Scroll-Frames/
title: Scroll Frames
order: 500
category: Examples using LibDoc
- url: https://olivier3lanc.github.io/seemap/
title: SEEMAP
order: 500
category: Examples using LibDoc
# Example remote URL
- url: https://github.com/olivier3lanc/Jekyll-LibDoc
title: <span class="i-github u-mr-xxs"></span> Jekyll LibDoc
order: 510
category: External resources
- url: https://pages.github.com
title: Github Pages
order: 510
category: External resources
- url: https://jekyllrb.com
title: Jekyll
order: 510
category: External resources
# BADGES
# Feature that allows to display badges into the footer https://shields.io image html and url
shields:
- image_html: <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/olivier3lanc/LibDoc-remote-demo?logo=github&style=flat-square">
link_url: https://github.com/olivier3lanc/LibDoc-remote-demo
- image_html: <img alt="no trackers, no cookies and no analytics" title="This website has no trackers, no cookies and no analytics. Only feedback is important :)" src="https://img.shields.io/badge/no%20trackers|cookies|analytics-Just%20feedback-green?style=flat-square">
link_url: 'mailto:olivier3lanc@gmail.com'
# ASSETS
# Settings for the assets layout
assets:
# START PATH
# The path from which files are available to download. '/' is the root
path_from_root: /
# List of extension files you wish to display on assets layout
extensions_enabled:
- pdf
- js
- css
- ttf
- woff
- woff2
- otf
- zip
- sketch
- svg
- jpg
- jpeg
- gif
- png
- webp
- psd
- ai
- heic
- mp4
- webm
- ogv
# IMAGES
# Array list of image extensions (without point) to display as image into asset grid
image_extensions:
- svg
- jpg
- jpeg
- gif
- png
- webp
# SYNTAX HIGHLIGHTER / PRISM
# Settings for Prism syntax highlighter used in LibDoc
# https://prismjs.com/
prism:
# THEME
# coy, dark, funky, okaidia, twilight, solarizedlight, tomorrow,
theme: tomorrow
# FONT SIZE
# CSS font-size property override for <code>
font_size: 0.9em
# LINE HEIGHT
# CSS line-height property override for <code>
line_height: 1.4em
# LANGUAGES TO ENABLE
# Uncomment lines to enable language
languages:
- markup
- css
- clike
- javascript
#- abap
#- abnf
#- actionscript
#- ada
#- agda
#- al
#- antlr4
#- apacheconf
#- apex
#- apl
#- applescript
#- aql
#- arduino
#- arff
#- asciidoc
#- aspnet
#- asm6502
#- autohotkey
#- autoit
#- bash
#- basic
#- batch
#- bbcode
#- birb
#- bison
#- bnf
#- brainfuck
#- brightscript
#- bro
#- bsl
#- c
#- csharp
#- cpp
#- cfscript
#- chaiscript
#- cil
#- clojure
#- cmake
#- cobol
#- coffeescript
#- concurnas
#- csp
#- coq
#- crystal
#- css-extras
#- csv
#- cypher
#- d
#- dart
#- dataweave
#- dax
#- dhall
#- diff
#- django
#- dns-zone-file
#- docker
#- dot
#- ebnf
#- editorconfig
#- eiffel
#- ejs
#- elixir
#- elm
#- etlua
#- erb
#- erlang
#- excel-formula
#- fsharp
#- factor
#- false
#- firestore-security-rules
#- flow
#- fortran
#- ftl
#- gml
#- gcode
#- gdscript
#- gedcom
#- gherkin
#- git
#- glsl
#- go
#- graphql
#- groovy
#- haml
#- handlebars
#- haskell
#- haxe
#- hcl
#- hlsl
#- hoon
#- http
#- hpkp
#- hsts
#- ichigojam
#- icon
#- icu-message-format
#- idris
#- ignore
#- inform7
#- ini
#- io
#- j
#- java
#- javadoc
#- javadoclike
#- javastacktrace
#- jexl
#- jolie
#- jq
#- jsdoc
#- js-extras
#- json
#- json5
#- jsonp
#- jsstacktrace
#- js-templates
#- julia
#- keyman
#- kotlin
#- kumir
#- latex
#- latte
#- less
#- lilypond
#- liquid
#- lisp
#- livescript
#- llvm
#- log
#- lolcode
#- lua
#- makefile
- markdown
# - markup-templating
#- matlab
#- mel
#- mizar
#- mongodb
#- monkey
#- moonscript
#- n1ql
#- n4js
#- nand2tetris-hdl
#- naniscript
#- nasm
#- neon
#- nevod
#- nginx
#- nim
#- nix
#- nsis
#- objectivec
#- ocaml
#- opencl
#- openqasm
#- oz
#- parigp
#- parser
#- pascal
#- pascaligo
#- psl
#- pcaxis
#- peoplecode
#- perl
#- php
#- phpdoc
#- php-extras
#- plsql
#- powerquery
#- powershell
#- processing
#- prolog
#- promql
#- properties
#- protobuf
#- pug
#- puppet
#- pure
#- purebasic
#- purescript
#- python
#- qsharp
#- q
#- qml
#- qore
#- r
#- racket
#- jsx
#- tsx
#- reason
#- regex
#- rego
#- renpy
#- rest
#- rip
#- roboconf
#- robotframework
#- ruby
#- rust
#- sas
#- sass
- scss
#- scala
#- scheme
#- shell-session
#- smali
#- smalltalk
#- smarty
#- sml
#- solidity
#- solution-file
#- soy
#- sparql
#- splunk-spl
#- sqf
#- sql
#- squirrel
#- stan
#- iecst
#- stylus
#- swift
#- t4-templating
#- t4-cs
#- t4-vb
#- tap
#- tcl
#- tt2
#- textile
#- toml
#- turtle
#- twig
#- typescript
#- typoscript
#- unrealscript
#- uri
#- v
#- vala
#- vbnet
#- velocity
#- verilog
#- vhdl
#- vim
#- visual-basic
#- warpscript
#- wasm
#- wiki
#- wolfram
#- xeora
# - xml-doc
#- xojo
#- xquery
- yaml
#- yang
#- zig
# LIBDOC BACKLINK
# Link powered by LibDoc - Uncomment to remove
# disable_powered_by_link: true