-
Notifications
You must be signed in to change notification settings - Fork 61
/
config.rb
508 lines (432 loc) · 15.9 KB
/
config.rb
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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
require 'pygments'
require 'open3'
activate :directory_indexes
activate :syntax
module ::Middleman::Syntax::Highlighter
def self.highlight(code, language=nil, opts={})
language ||= 'text' # disable language guessing
Pygments.highlight(code, lexer: language)
end
end
set :markdown_engine, :redcarpet
set :markdown, :fenced_code_blocks => true, :smartypants => true, :tables => true, :strikethrough => true
set :css_dir, 'css'
set :js_dir, 'js'
set :images_dir, 'img'
page '/docs/*', layout: 'doc'
helpers do
def twitter_share_url(url, doc)
full_url = "https://learnxinyminutes.com" + (url || "")
text = (doc || "")
qs = URI.encode_www_form("url" => full_url, "text" => text)
"https://twitter.com/intent/tweet?#{qs}"
end
end
# Build-specific configuration
configure :build do
# For example, change the Compass output style for deployment
# activate :minify_css
# Minify Javascript on build
# activate :minify_javascript
# Enable cache buster
# activate :cache_buster
# Use relative URLs
# activate :relative_assets
# Compress PNGs after build
# First: gem install middleman-smusher
# require "middleman-smusher"
# activate :smusher
# Or use a different image path
# set :http_path, "/Content/images/"
end
#
###
# Compass
###
# Susy grids in Compass
# First: gem install susy
# require 'susy'
# Change Compass configuration
# compass_config do |config|
# config.output_style = :compact
# end
###
# Page options, layouts, aliases and proxies
###
# Per-page layout changes:
#
# With no layout
# page "/path/to/file.html", :layout => false
#
# With alternative layout
# page "/path/to/file.html", :layout => :otherlayout
#
# A path which all have the same layout
# with_layout :admin do
# page "/admin/*"
# end
# Proxy (fake) files
# page "/this-page-has-no-template.html", :proxy => "/template-file.html" do
# @which_fake_page = "Rendering a fake page with a variable"
# end
###
# Helpers
###
# Automatic image dimensions on image_tag helper
# activate :automatic_image_sizes
# Methods defined in the helpers block are available in templates
# helpers do
# def some_helper
# "Helping"
# end
# end
IGNORED = [
"js/script",
".htaccess",
"404.html",
"crossdomain.xml",
"favicon.ico",
"humans.txt",
"index.html",
"LICENSE",
"LICENSE.txt",
"robots.txt",
"js/script.js",
"css/dark.css",
"css/index.css",
"css/light.css",
"css/main.css",
"css/normalize.css",
"css/screen.css",
"docs/Gemfile",
"docs/Gemfile.lock",
"docs/hre.csv",
"docs/pets.csv",
"docs/Rakefile",
"docs/README.markdown",
"docs/LICENSE.txt",
"docs/images/cairo/build.png",
"docs/images/cairo/connect.png",
"docs/images/cairo/connect2.png",
"docs/images/cairo/declare.png",
"docs/images/cairo/deploy.png",
"docs/images/solidity/",
"docs/images/solidity/copy-address.png",
"docs/images/solidity/metamask-kovan.png",
"docs/images/solidity/remix-add-token.png",
"docs/images/solidity/remix-choose-file.png",
"docs/images/solidity/remix-compile.png",
"docs/images/solidity/remix-deploy.png",
"docs/images/solidity/remix-interact.png",
"docs/images/solidity/remix-solidity.png",
"docs/images/solidity/remix-testnet.png",
"docs/images/solidity/send-link.png",
"docs/README",
"docs/CONTRIBUTING",
"docs/tests/yaml.rb",
"docs/tests/encoding.rb",
"docs/tests/yaml",
"docs/tests/encoding",
"docs/file.html.erb",
"docs/.github/PULL_REQUEST_TEMPLATE.md",
"docs/.github/ISSUE_TEMPLATE.md",
"docs/.github/PULL_REQUEST_TEMPLATE",
"docs/.github/ISSUE_TEMPLATE",
"docs/.github/CODEOWNERS",
"docs/.gitattributes",
"docs/.gitignore",
"docs/.mailmap",
"docs/.travis.yml",
"docs/tmp.txt",
]
class Article
attr_accessor :category, :name, :contributors, :contributor_count, :filename, :rawcode, :url, :language, :translations, :translators
def initialize(r)
@resource = r
@path = r.path
meta = r.metadata[:page]
set_name_and_category(meta)
set_contributors(meta)
set_contributor_count(r.path)
set_rawcode(r)
@language = r.metadata[:page].fetch(:lang, "en")
@translations = []
@translators = r.metadata[:page].fetch(:translators, [])
@url = r.url
end
def set_name_and_category(meta)
begin
@name = meta.fetch(:name, nil)
if @name.nil?
@name = meta.fetch(:language, nil)
end
@category = meta.fetch(:category, nil)
if @category.nil? && @name
@category = "language"
else
@category = meta.fetch(:category, "meta")
end
@name_key = case @category
when "language" then :language
when "framework" then :framework
when "tool" then :tool
else :name
end
@name = meta.fetch(@name_key, "")
rescue e
puts "ERROR: " + e.to_s
@name = ""
@category = "meta"
end
end
def set_contributors(meta)
# Get a list of the authors
@contributors = meta.fetch(:contributors, nil)
if @contributors.nil?
@contributors = [[meta[:author], meta[:author_url]]]
end
end
def set_contributor_count(path)
dir, filename = File.split(path)
# remove "docs/"
dir = dir.split(File::SEPARATOR)[1..-1]
path = File.join(*dir, filename + '.markdown')
# Returns no output but status code 0
# stdout, stderr, status = Open3.capture3('git', 'shortlog', '-s', '--', path, chdir: 'source/docs')
stdout, stderr, status = Open3.capture3('git', 'blame', '--line-porcelain', '--', path, chdir: 'source/docs')
if status.success?
names = stdout.each_line.select { |line| line.start_with?('author ') }
.map { |line| line.sub('author ', '').strip }
cnt = Set::new(names).length + @contributors.length - 2
@contributor_count = (cnt > 0 ? cnt : 0)
else
puts "git blame error: #{stderr}"
@contributor_count = 0
end
end
def set_rawcode(r)
meta = r.metadata[:page]
@filename = meta.fetch(:filename, nil)
if @filename.nil?
@rawcode = nil
return
end
s = nil
File::open("source/#{r.path}.markdown") {|f|
s = StringScanner.new(f.read)
}
code = ''
until s.eos?
s.skip_until(/^```.*$/)
out = s.scan_until(/^```/)
if out.nil?
break
end
code += out
end
@rawcode = code.gsub('```', '')
end
def to_s
"Article #{@category}: #{@name} (#{@contributors}): #{@path}"
end
def add_translation a
@translations.push a
end
end
class ArticleManager
attr_accessor :articles, :articles_by_name, :articles_by_category_en, :categories_en
def initialize(sitemap)
@articles = sitemap.resources.select{|r|
not IGNORED.include?(r.path)
}.map{|r|
Article.new(r)
}.sort{|a1, a2| a1.name.downcase <=> a2.name.downcase }
@articles_en = @articles.select{|a|a.language == "en"}
@articles_by_category = @articles.group_by{|r| r.category}
@articles_by_name = @articles.group_by{|r| r.name}
@articles_by_category_en = @articles_en.group_by{|r| r.category}
@articles_by_name_en = @articles_en.group_by(&:name)
@categories_en = ["language", "framework", "tool", "Algorithms & Data Structures"] | articles_by_category_en.keys
#@articles.each{|a| puts a.url + ": " + a.language + " (" + a.category + ")"}
@articles.select{|a| a.language != "en" and not a.name.nil?}.each{|a|
a2 = @articles_by_name_en.fetch(a.name, [nil])[0]
if not a2.nil? and not a2.translations.nil?
a2.add_translation a
end
}
end
def get(page)
get_article(page)
end
def get_category_display_name(c)
case c
when "language" then "Languages"
when "framework" then "Frameworks and Libraries"
when "tool" then "Tools"
else c
end
end
def get_article(page)
name = page.fetch(:name,
page.fetch(:tool,
page.fetch(:framework,
page.fetch(:language, nil))))
language = page.fetch(:lang, "en")
@articles_by_name.fetch(name).select{|a|
a.language == language
}[0]
end
def contributors(page)
get_article(page).contributors
end
def name(page)
get_article(page).name
end
def contributor_count(page)
get_article(page).contributor_count
end
def filename(page)
get_article(page).filename
end
def rawcode(page)
get_article(page).rawcode
end
end
class I18N
def initialize(articles)
@articles = articles
end
def t(data, page, key)
language = @articles.get(page).language.sub('-', '_')
translations = data.i18n[language] || data.i18n['default']
translations[key] || data.i18n['default'][key]
end
def p(data, page, key, num)
language = @articles.get(page).language.sub('-', '_')
newkey = key
if num == 1
newkey += '-one'
else
newkey += '-other'
end
data.i18n.dig(language, newkey) || data.i18n.dig(language, key) || data.i18n.dig('default', newkey) || data.i18n.dig('default', key)
end
end
# Count contributors
ready do
articles = ArticleManager.new(sitemap)
set :articles, articles
set :i18n, I18N.new(articles)
articles.articles.select{|a| not a.filename.nil?}.each{|a|
proxy "/docs/files/#{a.filename}", "/docs/file.html", :locals => {:rawcode => a.rawcode}, :ignore => true, :layout => false
}
end
# python3 -> python
# and python -> pythonlegacy (no redirect)
redirect 'docs/python3/index.html', to: '/docs/python/'
redirect 'docs/ar-ar/python3-ar/index.html', to: '/docs/ar-ar/python-ar/'
redirect 'docs/cs-cz/python3/index.html', to: '/docs/cs-cz/python/'
redirect 'docs/de-de/python3-de/index.html', to: '/docs/de-de/python-de/'
redirect 'docs/el-gr/python3-gr/index.html', to: '/docs/el-gr/python-gr/'
redirect 'docs/es-es/python3-es/index.html', to: '/docs/es-es/python-es/'
redirect 'docs/fr-fr/python3-fr/index.html', to: '/docs/fr-fr/python-fr/'
redirect 'docs/it-it/python3-it/index.html', to: '/docs/it-it/python-it/'
redirect 'docs/ja-jp/python3-jp/index.html', to: '/docs/ja-jp/python-jp/'
redirect 'docs/pt-br/python3-pt/index.html', to: '/docs/pt-br/python-pt/'
redirect 'docs/ru-ru/python3-ru/index.html', to: '/docs/ru-ru/python-ru/'
redirect 'docs/tr-tr/python3-tr/index.html', to: '/docs/tr-tr/python-tr/'
redirect 'docs/vi-vn/python3-vi/index.html', to: '/docs/vi-vn/python-vi/'
redirect 'docs/zh-cn/python3-cn/index.html', to: '/docs/zh-cn/python-cn/'
# brainfuck -> bf
redirect 'docs/brainfuck/index.html', to: '/docs/bf/'
redirect 'docs/cs-cz/brainfuck/index.html', to: '/docs/cs-cz/bf/'
redirect 'docs/de-de/brainfuck-de/index.html', to: '/docs/de-de/bf-de/'
redirect 'docs/es-es/brainfuck-es/index.html', to: '/docs/es-es/bf-es/'
redirect 'docs/fa-ir/brainfuck-fa/index.html', to: '/docs/fa-ir/bf-fa/'
redirect 'docs/fr-fr/brainfuck-fr/index.html', to: '/docs/fr-fr/bf-fr/'
redirect 'docs/it-it/brainfuck-it/index.html', to: '/docs/it-it/bf-it/'
redirect 'docs/ko-kr/brainfuck-kr/index.html', to: '/docs/ko-kr/bf-kr/'
redirect 'docs/nl-nl/brainfuck-nl/index.html', to: '/docs/nl-nl/bf/'
redirect 'docs/pl-pl/brainfuck-pl/index.html', to: '/docs/pl-pl/bf-pl/'
redirect 'docs/pt-br/brainfuck-pt/index.html', to: '/docs/pt-br/bf-pt/'
redirect 'docs/pt-pt/brainfuck-pt/index.html', to: '/docs/pt-pt/bf-pt/'
redirect 'docs/ru-ru/brainfuck-ru/index.html', to: '/docs/ru-ru/bf/'
redirect 'docs/sv-se/brainfuck-sv/index.html', to: '/docs/sv-se/bf-sv/'
redirect 'docs/tr-tr/brainfuck-tr/index.html', to: '/docs/tr-tr/bf-tr/'
redirect 'docs/zh-cn/brainfuck-cn/index.html', to: '/docs/zh-cn/bf-cn/'
# older brainfuck redirects
redirect 'docs/sv-sv/brainfuck-sv/index.html', to: '/docs/sv-se/bf-sv/'
redirect 'docs/bf-it/index.html', to: '/docs/it-it/bf-it/'
redirect 'docs/pt-br/brainfuck/index.html', to: '/docs/pt-br/bf-pt/'
redirect 'docs/pt-pt/brainfuck/index.html', to: '/docs/pt-pt/bf-pt/'
# hd-hd -> hi-in
redirect 'docs/hd-hd/amd/index.html', to: '/docs/hi-in/amd/'
redirect 'docs/hd-hd/d/index.html', to: '/docs/hi-in/d/'
redirect 'docs/hd-hd/json-hd/index.html', to: '/docs/hi-in/json-hd/'
# ta_in -> ta-in
redirect 'docs/ta_in/css-ta/index.html', to: '/docs/ta-in/css-ta/'
redirect 'docs/ta_in/javascript-ta/index.html', to: '/docs/ta-in/javascript-ta/'
redirect 'docs/ta_in/json-ta/index.html', to: '/docs/ta-in/json-ta/'
redirect 'docs/ta_in/xml-ta/index.html', to: '/docs/ta-in/xml-ta/'
redirect 'docs/ta_in/css/index.html', to: '/docs/ta-in/css-ta/'
redirect 'docs/ta_in/javascript/index.html', to: '/docs/ta-in/javascript-ta/'
redirect 'docs/ta_in/json/index.html', to: '/docs/ta-in/json-ta/'
redirect 'docs/ta_in/xml/index.html', to: '/docs/ta-in/xml-ta/'
# ua-ua -> uk-ua
redirect 'docs/ua-ua/bash-ua/index.html', to: '/docs/uk-ua/bash-ua/'
redirect 'docs/ua-ua/json-ua/index.html', to: '/docs/uk-ua/json-ua/'
redirect 'docs/ua-ua/javascript-ua/index.html', to: '/docs/uk-ua/javascript-ua/'
# repeat language codes in filenames
redirect 'docs/fa-ir/css/index.html', to: '/docs/fa-ir/css-fa/'
redirect 'docs/fa-ir/javascript/index.html', to: '/docs/fa-ir/javascript-fa/'
redirect 'docs/fr-fr/d/index.html', to: '/docs/fr-fr/d-fr/'
redirect 'docs/fr-fr/haskell/index.html', to: '/docs/fr-fr/haskell-fr/'
redirect 'docs/fr-fr/markdown/index.html', to: '/docs/fr-fr/markdown-fr/'
redirect 'docs/fr-fr/php/index.html', to: '/docs/fr-fr/php-fr/'
redirect 'docs/fr-fr/php/index.html', to: '/docs/fr-fr/php-fr/'
redirect 'docs/fr-fr/scala/index.html', to: '/docs/fr-fr/scala-fr/'
redirect 'docs/fr-fr/vim/index.html', to: '/docs/fr-fr/vim-fr/'
redirect 'docs/hu-hu/go/index.html', to: '/docs/hu-hu/go-hu/'
redirect 'docs/hu-hu/ruby/index.html', to: '/docs/hu-hu/ruby-hu/'
redirect 'docs/ja-jp/php/index.html', to: '/docs/ja-jp/php-jp/'
redirect 'docs/pt-br/amd/index.html', to: '/docs/pt-br/amd-pt/'
redirect 'docs/pt-br/csharp/index.html', to: '/docs/pt-br/csharp-pt/'
redirect 'docs/pt-br/elixir/index.html', to: '/docs/pt-br/elixir-pt/'
redirect 'docs/pt-br/pythonstatcomp/index.html', to: '/docs/pt-br/pythonstatcomp-pt/'
redirect 'docs/pt-pt/swift/index.html', to: '/docs/pt-pt/swift-pt/'
redirect 'docs/ro-ro/latex/index.html', to: '/docs/ro-ro/latex-ro/'
redirect 'docs/sk-sk/bash/index.html', to: '/docs/sk-sk/bash-sk/'
redirect 'docs/sk-sk/coffeescript/index.html', to: '/docs/sk-sk/coffeescript-sk/'
redirect 'docs/sk-sk/elixir/index.html', to: '/docs/sk-sk/elixir-sk/'
redirect 'docs/sk-sk/git/index.html', to: '/docs/sk-sk/git-sk/'
redirect 'docs/sk-sk/json/index.html', to: '/docs/sk-sk/json-sk/'
redirect 'docs/sk-sk/ruby/index.html', to: '/docs/sk-sk/ruby-sk/'
redirect 'docs/tr-tr/css/index.html', to: '/docs/tr-tr/css-tr/'
redirect 'docs/zh-cn/common-lisp/index.html', to: '/docs/zh-cn/common-lisp-cn/'
redirect 'docs/zh-cn/javascript/index.html', to: '/docs/zh-cn/javascript-cn/'
redirect 'docs/zh-cn/sql/index.html', to: '/docs/zh-cn/sql-cn/'
redirect 'docs/zh-cn/go-zh/index.html', to: '/docs/zh-cn/go-cn/'
# minor filename mistakes
redirect 'docs/pt-br/asymptoticnotation-pt/index.html', to: '/docs/pt-br/asymptotic-notation-pt/'
redirect 'docs/fr-fr/kotlin.html-fr/index.html', to: '/docs/fr-fr/kotlin-fr/'
# wrong directory
redirect 'docs/rust-pt/index.html', to: '/docs/pt-br/rust-pt/'
# improper filenames
redirect 'docs/es-es/learnsmallbasic-es/index.html', to: '/docs/es-es/smallbasic-es/'
redirect 'docs/ru-ru/learnvisualbasic-ru/index.html', to: '/docs/ru-ru/visualbasic-ru/'
redirect 'docs/zh-cn/clojure-macro-cn/index.html', to: '/docs/zh-cn/clojure-macros-cn/'
# perl6 -> raku
redirect 'docs/perl6/index.html', to: '/docs/raku/'
redirect 'docs/perl6-pod/index.html', to: '/docs/raku-pod/'
redirect 'docs/es-es/perl6-es/index.html', to: '/docs/es-es/raku-es/'
# fortran
redirect 'docs/fortran95/index.html', to: '/docs/fortran/'
redirect 'docs/fortran90/index.html', to: '/docs/fortran/'
redirect 'docs/zh-cn/fortran95-cn/index.html', to: '/docs/zh-cn/fortran-cn/'
# lowercase
redirect 'docs/ATS/index.html', to: '/docs/ats/'
redirect 'docs/CHICKEN/index.html', to: '/docs/chicken/'
redirect 'docs/LOLCODE/index.html', to: '/docs/lolcode/'
redirect 'docs/de-de/LOLCODE-de/index.html', to: '/docs/de-de/lolcode-de/'
redirect 'docs/fr-fr/HTML-fr/index.html', to: '/docs/fr-fr/html-fr/'
redirect 'docs/no-nb/JSON-no/index.html', to: '/docs/no-nb/json-no/'