-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy path_config.yml
261 lines (222 loc) · 8.24 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
# Base configuration
remote_theme: mmistakes/minimal-mistakes@4.24.0
#theme: minimal-mistakes-jekyll
# Default minimal-mistakes skins
# - # "default", "air", "aqua", "contrast", "dark", "dirt", "mint", "neon", "plum", "sunrise"
# Additional skins
# - "oi-midnight", "oi-light", "oi-dark"
# NOTE: This one is not used at all, an d has no effect anymore, as we have our custom dynamic skin loading/swapping solution yet,
# that is turned on by default via "skin_switchable: true"
minimal_mistakes_skin: "oi-light"
skin_switchable: true
# Disable caching of content to disk in order to skip creating a .jekyll-cache or similar directory
disable_disk_cache: true
# NOTE: For proper working of liquid `absolute_url` this must be provided (otherwise construct using it e.g. sitemap plugin, will not work properly)
# For local builds you can use the `jekyll serve --host` param to override
url: https://syslog-ng.github.io
# If you’re publishing on GitHub Pages you should update only your _config.yml as GitHub Pages doesn’t load plugins via Bundler.
plugins:
- jekyll-remote-theme
- jekyll-sitemap # Jekyll plugin to silently generate a sitemaps.org compliant sitemap for your Jekyll site.
- jekyll-gist # Liquid tag for displaying GitHub Gists in Jekyll sites.
- jekyll-include-cache # Liquid tag that caches Liquid includes.
- jekyll-github-metadata
# Whitelist plugins under safe mode.
whitelist:
- jekyll-remote-theme
- jekyll-sitemap
- jekyll-gist
- jekyll-include-cache
# NOTE: Overiding theme defaults https://jekyllrb.com/docs/themes/#overriding-theme-defaults
# Jekyll will look first to your site’s content before looking to the theme’s defaults for any requested file in the following folders:
# /assets
# /_data
# /_layouts
# /_includes
# /_sass
#source: doc
# Reading Files
#
# Every file or directory beginning with the following characters:
# ., _ , # or ~
# in the source directory will not be included in the destination folder. Such paths will have to be explicitly specified via the config file in the
# include directive to make sure they’re copied over
# In Jekyll 3, the `exclude` configuration option replaces the default exclusion list.
# In Jekyll 4, user-provided entries get added to the default exclusion list instead and the `include` option can be used to override the default exclusion list entries.
#
# DANGER: This one above is a big lie, does not work that way at all
# Add everything explicitely instead to excluded: but DO NOT if it must be, and presented in included:
#
include:
- .htaccess
- assets/css
- assets/images
- assets/js/main.min.js
# Only lunr is not included now to main.min.js
- assets/js/lunr
# Input of site.data.links
- _data/links/
exclude:
- .reftime
- .bundle/
- .vendor/
- .vscode/
- .git
- .github
- README.md # The one in the root belongs to the GitHub repository page, not to the generated final site, use index.md
# TODO: These are now packed into assets/js/main.min.js, not needed, but the _site building still adds them, double check the references why
# Also the doc snippet above is lieing, if this is presented the include: will not add e.g. assets/js/lunr even it is presented over there
#- assets/js
- _js/
- _tools/
- Gemfile
- Gemfile.lock
- node_modules
# Shell we add to the generated _site as well?
- LICENSE.*
# Sass/SCSS
# If you are using Sass @import statements, you’ll need to ensure that your sass_dir is set to the base directory that contains your Sass files
# https://jekyllrb.com/docs/assets/#sassscss
sass:
sass_dir: _sass/minimal-mistakes
style: compressed # https://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
# Note: If you assign footer_scripts the theme’s /assets/js/main.min.js file will be deactivated.
# This script includes jQuery and various other plugins that you’ll need to find replacements for and include separately.
# https://mmistakes.github.io/minimal-mistakes/docs/javascript/
#
#footer_scripts:
# ------------------------------------------------------------
# Title
title: syslog-ng documentation
masthead_title: syslog-ng documentation
# Author/Organization info to be displayed in the templates
author:
name: OpenSource Community
url: https://github.com/syslog-ng/syslog-ng
google_site_verification: "B_ASm3harCQhWZo2naEV8zw-DuQ1NYUEnPZIac-mqy4"
# When using this template with a project (repository) page set the baseurl to '/project-name'
# For user/organization pages set this to an empty string
# When working locally use jekyll serve --baseurl '' so that you can view everything at localhost:4000
# See http://jekyllrb.com/docs/github-pages/ or https://byparker.com/blog/2014/clearing-up-confusion-around-baseurl/ for more info
baseurl: ""
# Point the logo URL at a file in your repo or hosted elsewhere by your organization
logourl: /assets/images/favicons/mstile-150x150.png
# logoalt: The D.C. flag
collections_dir: doc
collections:
doc-guide:
name: Documentation
output: true
admin-guide:
name: Administration
output: true
dev-guide:
name: Development
output: true
# Global defult permalink format
# https://jekyllrb.com/docs/permalinks/
# GitHub project name we use as collection name and root
#permalink: /:path/
# NOTE: the above is always expanded like this, for collections it seems (not mentioned correctly in the documentataion)
#permalink: /:collection/:path/:basename
# Defaults
defaults:
# All pages
- scope:
path: "" # an empty string here means all files in the project
values:
layout: single
toc: true
toc_sticky: true
toc_hide_empty: true
sidebar:
nav: ""
# Documentation guide pages
- scope:
# NOTE: type can be a collection name
type: doc-guide
values:
sidebar:
nav: "doc-guide-nav"
# Administrator guide pages
- scope:
type: admin-guide
values:
sidebar:
nav: "admin-guide-nav"
# Developer guide pages
- scope:
type: dev-guide
values:
sidebar:
nav: "dev-guide-nav"
# Search settings
search: true
# Setting search_full_content to true could impact page load performance!
search_full_content: true
search_from_masthead: true
search_provider: lunr
lunr:
# No we have all the valuable content in collections (collection.docs)
# that lunr indexes by default if search: true
# Standalone pages like, sitemap.xml, 404, etc. should not be searched
search_within_pages: false
test_text_1: "abrakadabra"
# search_provider: algolia
# algolia:
# application_id: # YOUR_APPLICATION_ID
# index_name: # YOUR_INDEX_NAME
# search_only_api_key: # YOUR_SEARCH_ONLY_API_KEY
# powered_by: # true (default), false
# Markdown and sytax higlighting
# https://jekyllrb.com/docs/configuration/markdown/
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
# https://kramdown.gettalong.org/options.html
markdown: kramdown
kramdown:
syntax_highlighter: rouge # default
syntax_highlighter_opts:
default_lang: c
guess_lang: true
block:
line_numbers: false
input: GFM # default
hard_wrap: false
auto_ids: true
toc_levels: 1..6
smart_quotes: lsquo,rsquo,ldquo,rdquo
footnote_nr: 1
# entity_output: as_char
# enable_coderay: false
atom_feed:
hide: true
twitter:
username: sngOSE
# https://jch.penibelst.de/
compress_html:
profile: true
clippings: all
endings: all
ignore:
# do not use yet, too slow and can cause issues in the final output
# envs: [ development ] disable compression in a given environment
envs: all
# These are introduced with our customized theme source, not part of mmistakes/minimal-mistakes
# Option to set the width of the page inner content part
# Any max-with css value, theme default is $max-width that is $x-large: 1280px in _variables.scss
page_content_width: 95%
sidebar:
sticky: true
nav_sub_items_scaled: true
nav_sub_items_ident: 0.5em
masthead:
# Option to hide masthead navigator in the page top bar
hide_navigator: true
# Option to make the masthead page top bar sticky
sticky: true
footer:
top_margin: 2em # originally 3em, needed if there are visible prev/next navigator buttons
product:
name: 'syslog-ng Open Source Edition'
short_name: 'syslog-ng OSE'
repository: syslog-ng/syslog-ng