Skip to content

Commit

Permalink
Finalize the documentation pages (#77)
Browse files Browse the repository at this point in the history
- 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 <[email protected]>
  • Loading branch information
mrgarris0n authored Jun 6, 2024
2 parents a609f93 + c8f1e48 commit fc8ee52
Show file tree
Hide file tree
Showing 16 changed files with 674 additions and 693 deletions.
1 change: 1 addition & 0 deletions _data/excluded_titles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
- '[Ii]nstallation'
- '[Oo]ption[s]?'
- '[Nn]ame'
- 'syslog-ng OSE configuration'
75 changes: 60 additions & 15 deletions _data/external_links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@ gh-syslog-ng-doc:
url: https://github.com/syslog-ng/syslog-ng.github.io
title: [ "syslog-ng OSE Doc on GitHub" ]

gh-syslog-ng-doc-actions:
id: gh-syslog-ng-doc-actions
url: https://github.com/syslog-ng/syslog-ng.github.io/actions
title: [ "syslog-ng Doc Actions on GitHub" ]

gh-syslog-ng-doc-issue-tracker:
id: gh-syslog-ng-doc-issue-tracker
url: https://github.com/syslog-ng/syslog-ng.github.io/issues
Expand Down Expand Up @@ -180,6 +185,11 @@ lic-lgpl:

### Site engine related links ###

jekyll:
id: jekyll
url: https://jekyllrb.com/
title: [ "Jekyll" ]

jekyll-config:
id: jekyll-config
url: https://jekyllrb.com/docs/configuration/
Expand All @@ -190,11 +200,41 @@ jekyll-dir-struct:
url: https://jekyllrb.com/docs/structure/
title: [ "Jekyll doc structure" ]

jekyll-sass:
id: jekyll-sass
url: https://jekyllrb.com/docs/assets/#sassscss
title: [ "Jekyll Sass" ]

jekyll-ruby-gems:
id: jekyll-ruby-gems
url: https://jekyllrb.com/docs/ruby-101/
title: [ "Jekyll Ruby Gems" ]

jekyll-liquid-filters:
id: jekyll-liquid-filters
url: https://jekyllrb.com/docs/liquid/filters/
title: [ "Jekyll liquid filter" ]

jekyll-plugins:
id: jekyll-plugins
url: https://jekyllrb.com/docs/plugins/
title: [ "Jekyll plugin" ]

jekyll-render-hooks:
id: jekyll-render-hooks
url: https://jekyllrb.com/docs/plugins/hooks/
title: [ "Jekyll plugin Hooks" ]

liquid:
id: liquid
url: https://shopify.github.io/liquid/
title: [ "liquid" ]

liquify-rb:
id: liquify-rb
url: https://fettblog.eu/snippets/jekyll/liquid-in-frontmatter/
title: [ "liquify.rb" ]

lunr-search-help:
id: lunr-search-help
url: https://lunrjs.com/guides/searching.html
Expand Down Expand Up @@ -238,6 +278,26 @@ apple-launchd:
url: https://developer.apple.com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html
title: [ "Apple launchd" ]

apple-predicates:
id: apple-predicates
url: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Predicates/Articles/pSyntax.html
title: [ "native macOS log message filtering using predicates" ]

apple-oslog-api:
id: apple-oslog-api
url: https://developer.apple.com/documentation/os/oslog
title: [ "OSLog API" ]

apple-oslog-api-bug:
id: apple-oslog-api-bug
url: https://openradar.appspot.com/radar?id=5597032077066240
title: [ "OSLog API bug" ]

apple-oslog-framwrk:
id: apple-oslog-framwrk
url: https://developer.apple.com/documentation/oslog?language=objc
title: [ "OSLog Framework" ]

autoconf-arch:
id: autoconf-arch
url: http://www.gnu.org/software/autoconf-archive/
Expand Down Expand Up @@ -388,21 +448,6 @@ linux-ha:
url: https://web.archive.org/web/20230422234943/http://www.linux-ha.org/wiki/Main_Page
title: [ "archived page of Linux-HA" ]

nat-macos:
id: nat-macos
url: https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Predicates/Articles/pSyntax.html
title: [ "native macOS log message filtering using predicates" ]

oslog-api-bug:
id: oslog-api-bug
url: https://openradar.appspot.com/radar?id=5597032077066240
title: [ "OSLog API bug" ]

oslog-fra:
id: oslog-fra
url: https://developer.apple.com/documentation/oslog?language=objc
title: [ "OSLog Framework" ]

proxy-pro:
id: proxy-pro
url: https://www.haproxy.com/blog/haproxy/proxy-protocol/
Expand Down
102 changes: 63 additions & 39 deletions _data/navigation.yml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions _includes/doc/common_links
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
This could help common link usages, like

{% include doc/common_links %}
[404 link via ref][ref:404]
{% include markdown_link_decl id="404" %}

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

[404 link via ref][ref:404]

Expand Down
12 changes: 2 additions & 10 deletions _js/custom/custom-init.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
/* ==========================================================================
Custom js init stuff
========================================================================== */

// $(function () {
//
// // 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
// //lunr.tokenizer.separator = /[\s\-_]+/
// lunr.tokenizer.separator = /[\s]+/
//
// });
Add custom, common js initialization related part here
========================================================================== */
Loading

0 comments on commit fc8ee52

Please sign in to comment.