-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathretype.yml
184 lines (140 loc) · 8.48 KB
/
retype.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
# To run this file please first download retype:
# npm install retypeapp --global
# (you will need to have npm installed => winget install OpenJS.NodeJS)
# Then run:
# retype start
# It will build the wiki and start a local server at http://localhost:5005
# -----------------------------------------------------------------------------
# Retype
# -----------------------------------------------------------------------------
input: . # Local path from this retype.yml file to the
# root of your project content files
# See also: output
# -----------------------------------------------------------------------------
output: wiki # Custom path to the output directory
# See also: input
# -----------------------------------------------------------------------------
#url: example.com # The base URL of your website
url: https://ets2la.github.io/documentation # Can also be a sub-domain
#url: example.com/docs # Can also include a sub-folder path
#url: https://example.com/docs # Can also include a protocol
# -----------------------------------------------------------------------------
branding:
title: ETS2LA # Your custom website title; keep it short
logo: /assets/favicon.ico # Path to a logo file
# logoDark: /assets/firstTimeSetup/logo.png # Path to a logo file to use in dark mode
# logoAlign: right # Align the logo to the right or the left
label: 2.0.0 # Optional label
# To remove the label, remove this config
colors:
label: # Label colors
text: "#ffffff" # Custom color for the label background
background: "#c65c15" # Custom color for the label text
# -----------------------------------------------------------------------------
links: # Custom links to add to the top bar
# See also: footer.links
- text: Github # The text to use for the link
link: https://github.com/Tumppi066/Euro-Truck-Simulator-2-Lane-Assist # Link to an internal file or external URL
icon: mark-github # A custom icon name, :emoji:, <svg>, or
# a path to a file
iconAlign: left # Icon alignment, to the left or right
target: blank # Custom target
# Use "blank" to open link in a new window
# -----------------------------------------------------------------------------
footer:
copyright: "Tumppi066 & Contributors © All rights reserved." # A custom copyright statement
links: # A list of links to include in the footer
# See also: links
- text: License # The text to use for the link
link: LICENSE # Point to an internal file or external URL
# -----------------------------------------------------------------------------
#cache:
# busting: query # Cache busting strategy
# Options: none | path | query (default)
# -----------------------------------------------------------------------------
#cname: example.com # The CNAME file value
# or, false to not create a CNAME file
# -----------------------------------------------------------------------------
#edit:
# repo: "" # The URL to source files for this project
# base: "" # Optional base path to a directory within repo
# branch: "" # Point to a custom branch within the repo
# label: "Edit this page" # A custom label for the generated link
# -----------------------------------------------------------------------------
editor: # Configure the page live editor functionality
# that is only available during `retype start`
enabled: true # false to disable and hide the live editor
# -----------------------------------------------------------------------------
exclude: # Files or folders to exclude from the build
# # See also: include
- "/plugins/Examples/*" # Wildcards are valid
# - "/src/temp.md" # Exclude a specific file
# -----------------------------------------------------------------------------
favicon: assets/favicon.ico # Path to a custom favicon, or
# just put a favicon.ico in your project root
# -----------------------------------------------------------------------------
generator:
recase: all # `none` to not recase any file or folder names
# By default, all generated file and folder names
# are generated in all lowercase
# -----------------------------------------------------------------------------
#include: # Files or folders to include in the build
# See also: exclude
# - "*.py" # Wildcards are valid
# -----------------------------------------------------------------------------
#integrations:
# googleAnalytics:
# id: "" # Your Google Analytics measurement id
# googleTagManager:
# id: "" # Your Google Tag Manager measurement id
# gravatar:
# enabled: true # false to disable using Gravatar images
# default: mp # What Gravatar profile image to use
# plausible: # Plausible.io integration
# domain: domain1.com,domain2.com # Your plausible domain(s)
# host: plausible.example.com # Custom Plausible host name
# -----------------------------------------------------------------------------
markdown: # Markdown configuration options
lineBreaks: hard # Switch between `soft` and `hard` line breaks
# -----------------------------------------------------------------------------
#meta:
# title: " | Widgets" # Appended to the <title> element on all pages
# -----------------------------------------------------------------------------
#search: # Custom configuration of the website search
# hotkeys:
# - "/" # Keyboard key to set focus in the search field
# # Default is "k"
# maxResults: 20 # Max number of search results to render
# minChars: 2 # Min characters required to trigger a search
# mode: full # The search index creation mode
# # Options include: full | partial | basic
# noResultsFoundMsg: "No results" # Message when no results are found
# placeholder: Search # Placeholder text used in the input field
# -----------------------------------------------------------------------------
serve:
host: 127.0.0.1 # Serve the website from this host location
#host: 127.0.0.1:5005 # Custom port also supported
port: 5005 # Custom port configured separately from host
watch:
mode: disk # Where to host files from during retype watch
# Options include: memory (default) | disk
polling: true # How Retype will listen for file changes
# Options: false (default) | true | number
validation: optimal # How thorough Retype is looking for file changes
# Options: fast | full | optimal (default)
# -----------------------------------------------------------------------------
start:
open: true # Do not automatically open web browser on start
# -----------------------------------------------------------------------------
snippets: # Custom code snippets configuration
# See: https://retype.com/components/code-snippet
lineNumbers: # Language shortcodes to enable line numbering on
- js
- py
# - none # `none` to disable line-numbering on snippets
# -----------------------------------------------------------------------------
templating:
enabled: true # Enable or disable the Retype content templating
liquid: false # Is Liquid syntax {% ... %} enabled?
# If true, Retype is incompatible with the
# GitBook style of component configuration