Skip to content

Commit fc8ee52

Browse files
authored
Finalize the documentation pages (#77)
- processing our special markdown notation [[ ]] still had numerous issues, like parsed inside code blocks - some markdown links still not skipped - processing order of [[ ]] [[ | ]] was bogus - added handling of a special form of our notation [[title|-]] that can protect the given title from further autolink/tooltip processing - prepared possible processing of our markdown notation in H2-H6 headings - Signed-off-by: Hofi <hofione@gmail.com>
2 parents a609f93 + c8f1e48 commit fc8ee52

File tree

16 files changed

+674
-693
lines changed

16 files changed

+674
-693
lines changed

_data/excluded_titles.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@
1111
- '[Ii]nstallation'
1212
- '[Oo]ption[s]?'
1313
- '[Nn]ame'
14+
- 'syslog-ng OSE configuration'

_data/external_links.yml

Lines changed: 60 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ gh-syslog-ng-doc:
3737
url: https://github.com/syslog-ng/syslog-ng.github.io
3838
title: [ "syslog-ng OSE Doc on GitHub" ]
3939

40+
gh-syslog-ng-doc-actions:
41+
id: gh-syslog-ng-doc-actions
42+
url: https://github.com/syslog-ng/syslog-ng.github.io/actions
43+
title: [ "syslog-ng Doc Actions on GitHub" ]
44+
4045
gh-syslog-ng-doc-issue-tracker:
4146
id: gh-syslog-ng-doc-issue-tracker
4247
url: https://github.com/syslog-ng/syslog-ng.github.io/issues
@@ -180,6 +185,11 @@ lic-lgpl:
180185

181186
### Site engine related links ###
182187

188+
jekyll:
189+
id: jekyll
190+
url: https://jekyllrb.com/
191+
title: [ "Jekyll" ]
192+
183193
jekyll-config:
184194
id: jekyll-config
185195
url: https://jekyllrb.com/docs/configuration/
@@ -190,11 +200,41 @@ jekyll-dir-struct:
190200
url: https://jekyllrb.com/docs/structure/
191201
title: [ "Jekyll doc structure" ]
192202

203+
jekyll-sass:
204+
id: jekyll-sass
205+
url: https://jekyllrb.com/docs/assets/#sassscss
206+
title: [ "Jekyll Sass" ]
207+
193208
jekyll-ruby-gems:
194209
id: jekyll-ruby-gems
195210
url: https://jekyllrb.com/docs/ruby-101/
196211
title: [ "Jekyll Ruby Gems" ]
197212

213+
jekyll-liquid-filters:
214+
id: jekyll-liquid-filters
215+
url: https://jekyllrb.com/docs/liquid/filters/
216+
title: [ "Jekyll liquid filter" ]
217+
218+
jekyll-plugins:
219+
id: jekyll-plugins
220+
url: https://jekyllrb.com/docs/plugins/
221+
title: [ "Jekyll plugin" ]
222+
223+
jekyll-render-hooks:
224+
id: jekyll-render-hooks
225+
url: https://jekyllrb.com/docs/plugins/hooks/
226+
title: [ "Jekyll plugin Hooks" ]
227+
228+
liquid:
229+
id: liquid
230+
url: https://shopify.github.io/liquid/
231+
title: [ "liquid" ]
232+
233+
liquify-rb:
234+
id: liquify-rb
235+
url: https://fettblog.eu/snippets/jekyll/liquid-in-frontmatter/
236+
title: [ "liquify.rb" ]
237+
198238
lunr-search-help:
199239
id: lunr-search-help
200240
url: https://lunrjs.com/guides/searching.html
@@ -238,6 +278,26 @@ apple-launchd:
238278
url: https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html
239279
title: [ "Apple launchd" ]
240280

281+
apple-predicates:
282+
id: apple-predicates
283+
url: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Predicates/Articles/pSyntax.html
284+
title: [ "native macOS log message filtering using predicates" ]
285+
286+
apple-oslog-api:
287+
id: apple-oslog-api
288+
url: https://developer.apple.com/documentation/os/oslog
289+
title: [ "OSLog API" ]
290+
291+
apple-oslog-api-bug:
292+
id: apple-oslog-api-bug
293+
url: https://openradar.appspot.com/radar?id=5597032077066240
294+
title: [ "OSLog API bug" ]
295+
296+
apple-oslog-framwrk:
297+
id: apple-oslog-framwrk
298+
url: https://developer.apple.com/documentation/oslog?language=objc
299+
title: [ "OSLog Framework" ]
300+
241301
autoconf-arch:
242302
id: autoconf-arch
243303
url: http://www.gnu.org/software/autoconf-archive/
@@ -388,21 +448,6 @@ linux-ha:
388448
url: https://web.archive.org/web/20230422234943/http://www.linux-ha.org/wiki/Main_Page
389449
title: [ "archived page of Linux-HA" ]
390450

391-
nat-macos:
392-
id: nat-macos
393-
url: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Predicates/Articles/pSyntax.html
394-
title: [ "native macOS log message filtering using predicates" ]
395-
396-
oslog-api-bug:
397-
id: oslog-api-bug
398-
url: https://openradar.appspot.com/radar?id=5597032077066240
399-
title: [ "OSLog API bug" ]
400-
401-
oslog-fra:
402-
id: oslog-fra
403-
url: https://developer.apple.com/documentation/oslog?language=objc
404-
title: [ "OSLog Framework" ]
405-
406451
proxy-pro:
407452
id: proxy-pro
408453
url: https://www.haproxy.com/blog/haproxy/proxy-protocol/

_data/navigation.yml

Lines changed: 63 additions & 39 deletions
Large diffs are not rendered by default.

_includes/doc/common_links

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
This could help common link usages, like
44

55
{% include doc/common_links %}
6-
[404 link via ref][ref:404]
6+
{% include markdown_link_decl id="404" %}
77

88
The final goal would be to add include of this file to _includes/doc/common_snippets and get it
9-
automatically included to each page, so make possible pure
9+
automatically included to each page, so make possible a pure
1010

1111
[404 link via ref][ref:404]
1212

_js/custom/custom-init.js

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
11
/* ==========================================================================
2-
Custom js init stuff
3-
========================================================================== */
4-
5-
// $(function () {
6-
//
7-
// // Override the default lunr tokenizer options, as a quick fix added _ to the list to get ignored the differences like option-1 and option_1
8-
// //lunr.tokenizer.separator = /[\s\-_]+/
9-
// lunr.tokenizer.separator = /[\s]+/
10-
//
11-
// });
2+
Add custom, common js initialization related part here
3+
========================================================================== */

0 commit comments

Comments
 (0)