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
|
# -*- mode: ruby -*-
# vi: set ft=ruby :
TITLE_FILTER_REGEXP = /(#\s|#{BadgesFilter::BADGES_MARKDOWN_PATTERN})/.freeze
preprocess do
badges_filter = BadgesFilter.new
# Do not process Markdown files with an underscore prefix
@items.delete_if { |i| i.identifier.match?('/**/_*.md') }
@items.each do |item|
if item.identifier.to_s.end_with?(".md") && !item.binary?
# If there isn't already a 'redirect_to' defined in the yaml frontmatter,
# use the text to assume the redirect URL.
unless item[:redirect_to]
if item.raw_content =~ /^This document was moved to \[.*\]\(.*\)/m
# Capture the intended page so the redirect page can redirect to it.
item[:redirect_to] = item.raw_content.match(/^This document was moved to \[.*\]\((.*)\)/m)[1]
# Correct the URL.
item[:redirect_to] = item[:redirect_to].gsub!(/\.md/, '.html')
end
else
# If the provided path is in Markdown
if item[:redirect_to].to_s.match(/.md/)
# If it's not a full URL
unless item[:redirect_to].to_s.match(/^http/)
# Correct it to HTML
item[:redirect_to] = item[:redirect_to].gsub!(/\.md/, '.html')
end
end
end
# We need to do some transformations for the title
# Let's extract and keep it first:
raw_title = item.raw_content.match(/^[#] .*$/).to_s
# If we don't have a title in frontmatter, reuse the one we just fetch
item[:title] ||= raw_title.gsub(TITLE_FILTER_REGEXP, '')
# Run badges filter with title fragment
item[:title_badge] = badges_filter.run_from_markdown(raw_title.match(BadgesFilter::BADGES_MARKDOWN_PATTERN).to_s)
end
if item.identifier.match?('/ee/architecture/**/*.md')
item[:layout] = 'blueprints/index'
item[:feedback] = false
item[:status] ||= 'proposed'
end
end
config[:search_backend] = ENV.fetch('SEARCH_BACKEND', 'google')
config[:google_search_key] = ENV.fetch('GOOGLE_SEARCH_KEY', '')
def get_online_versions
uri = URI('https://gitlab.com/gitlab-org/gitlab-docs/-/raw/main/content/versions.json')
response = Net::HTTP.get(uri)
parsed = JSON.parse(response, symbolize_names: true)
parsed[0]
rescue
{}
end
config[:online_versions] = get_online_versions
config[:release_dates] = get_release_dates
end
compile '/404.*' do
filter :erb
layout '/404.*'
write '/404.html'
end
compile '/**/*.html' do
layout '/default.*'
end
# Do not process Markdown files in ee/doc/drawers/
ignore '/ee/drawers/*.md'
# Do not process GitLab Operator's architectural design records
ignore '/operator/adr/*.md'
compile '/**/*.md' do
if item[:redirect_to].nil?
# If 'toc' is absent in a file's yaml frontmatter, show ToC.
# Set to 'toc: false' to disable it.
include_toc = item[:toc].nil? ? true : false
# Use GitlabKramdown with Rouge.
# https://gitlab.com/brodock/gitlab_kramdown
filter :gitlab_kramdown,
input: 'GitlabKramdown',
syntax_highlighter: 'rouge',
syntax_highlighter_opts: {
# In kramdown 2.0, the plaintext parser was removed and replaced by the
# :guess_lang option:
#
# - https://github.com/gettalong/kramdown/blob/master/doc/news/release_2_0_0.page
# - https://github.com/gettalong/kramdown/pull/573
guess_lang: true
},
default_lang: 'Plain Text',
hard_wrap: false,
auto_ids: true,
toc_levels: 2..5,
with_toc: include_toc
filter :convert_mermaid_html
filter :colorize_syntax,
default_colorizer: :rouge
# GitLab price / tiers specific badges
filter :badges
filter :md_to_html_ext
filter :admonition
filter :icons
filter :introduced_in
filter :tabs
if item[:layout].nil?
layout '/default.*'
else
layout "/#{item[:layout]}.*"
end
else
layout '/redirect.*'
end
end
# Do not compile minified assets
passthrough '/**/*.min.*'
compile '/index.*' do
filter :erb
layout '/home.*'
write '/index.html'
end
compile '/sitemap.*' do
filter :erb
write '/sitemap.xml'
end
compile '/robots.*' do
filter :erb
write '/robots.txt'
end
route '/**/*.{html,md}' do
if item.identifier =~ '/index.*'
'/index.html'
else
"#{item.identifier.without_ext}.html"
end
end
# Leave yaml files out
ignore '/_data/*.yaml'
compile '/**/*' do
unless item.identifier.ext == 'scss'
write item.identifier.to_s
end
end
layout '/**/*', :erb
# Leave the favicon alone.
passthrough '/favicon.ico'
|
