", type = "function" },
451 | { pattern = "https?://%S+", type = "function" },
452 | -- optimize consecutive dashes used in tables
453 | { pattern = "%-+", type = "normal" },
454 | },
455 | symbols = { },
456 | }
457 |
458 | -- Adjust the color on theme changes
459 | core.add_thread(function()
460 | while true do
461 | if initial_color ~= style.syntax["keyword2"] then
462 | for _, attr in pairs({"bold", "italic", "bold_italic"}) do
463 | style.syntax["markdown_"..attr] = style.syntax["keyword2"]
464 | end
465 | initial_color = style.syntax["keyword2"]
466 | end
467 | coroutine.yield(1)
468 | end
469 | end)
470 | ```
471 |
472 | ### Syntax fonts (Since 1.16.10)
473 |
474 | The syntax allows users to set different font styles (bold, italic, etc.) for different patterns.
475 | To change the font style of a token, add a Font to `style.syntax_fonts[token_type]`.
476 | For example:
477 | ```
478 | -- will ensure every "fancysyntax_fancy_token" is italic
479 | style.syntax_fonts["fancysyntax_fancy_token"] = renderer.font.load("myfont.ttf", 14 * SCALE, { italic = true })
480 | ```
481 |
482 | The markdown example automates this with a for loop.
483 |
484 | The limitations here are that fonts cannot be copied with different attributes, thus the font path has to be hardcoded.
485 | Other than that, abusing `style.syntax_fonts` may lead to **slow performance** and **high memory consumption**.
486 | This is very obvious when the user tries to resize the editor with `ctrl-scroll` or `ctrl+` and `ctrl-`.
487 | Please use it in moderation.
488 |
489 | ### Space handling (v2.1 (upcoming) / `master`)
490 |
491 | By default, Lite XL prepends a pattern `{ pattern = "%s+", type = "normal" }` to the syntax.
492 | This improves the performance drastically on lines that starts with whitespaces (eg. heavily indented lines)
493 | by matching the whitespace before other patterns in order to prevent Lite XL from iterating the entire syntax.
494 | However, there may be syntaxes that require matching spaces (eg. Markdown with indented blocks)
495 | so this can be disabled by setting `space_handling` to `false.`
496 |
497 | > To keep the space handling optimization or to support older versions of Lite XL,
498 | > `{ pattern = "%s+", type = "normal" }` can be added after patterns that require space.
499 |
500 | ### Simple patterns with multiple tokens (v1.16.10)
501 |
502 | This is an excerpt taken from the markdown plugin:
503 |
504 | ```lua
505 | local in_squares_match = "^%[%]"
506 | -- reference links
507 | {
508 | pattern = "^%s*%[%^()["..in_squares_match.."]+()%]: ",
509 | type = { "function", "number", "function" }
510 | },
511 | ```
512 |
513 | Sometimes it makes sense to highlight different parts of a pattern differently.
514 | An empty parentheses (`()`) in Lua patterns will return the position of the text in the parentheses.
515 | This will tell Lite XL when to change the type of token.
516 | For instance, `^%s*%[%^` is `"function"`, `["..in_squares_match.."]+` is `"number"` and `%]: ` is `"function"`.
517 |
518 | ### Subsyntaxes (Since v1.16.10)
519 |
520 | Lite XL supports embedding another syntax into the existing syntax.
521 | This is used to support code blocks inside the markdown syntax.
522 |
523 | For example:
524 | ```lua
525 | { pattern = { "```cpp", "```" }, type = "string", syntax = ".cpp" },
526 | ```
527 |
528 | This would highlight `` ```cpp `` and `` ``` `` with `"string"` while everything inside them will be highlighted with a syntax that matches `".cpp"`.
--------------------------------------------------------------------------------
/locales/en/tutorials/system-fonts.md:
--------------------------------------------------------------------------------
1 | # Using system fonts
2 |
3 | lite-xl does not provide a convenient way to use fonts on the system.
4 | There is literally _different APIs for the each platforms we support (Windows, Linux and Mac).
5 | This is where [fontconfig][1] comes to our rescue. fontconfig is
6 | installable on a lot of OSes.
7 |
8 | lite-xl has a [fontconfig plugin][2] that we can use to find system fonts.
9 |
10 | ## Installing fontconfig
11 | #### Windows
12 | [mingw-w64-fontconfig][3] provides a build that can be used directly on Windows.
13 | Download the file, extract it to somewhere and (optionally) add it to the PATH.
14 |
15 | #### Linux
16 | Check your distro-specific instructions.
17 |
18 | ```sh
19 | # ubuntu / debian
20 | apt install fontconfig
21 | # arch
22 | pacman -Su fontconfig
23 | # fedora
24 | dnf install fontconfig
25 | ...
26 | ```
27 |
28 | #### MacOS
29 |
30 | ```sh
31 | brew install fontconfig
32 | ```
33 |
34 | ### Setting up
35 |
36 | 1. Install the plugin
37 | 2. Put this in your user module:
38 |
39 | ```lua
40 | local fontconfig = require "plugins.fontconfig"
41 | fontconfig.use {
42 | font = { name = "sans", size = 13 * SCALE },
43 | code_font = { name = "monospace", size = 13 * SCALE }
44 | }
45 | ```
46 |
47 | `"sans"` and `"monospace"` can be any [fontconfig syntax. (check "Font Names")][4]
48 |
49 |
50 | Note that the font might not load immediately (because we need to wait for `fc-match` to return.
51 | If you want that, replace `fontconfig.use` with `fontconfig.use_blocking`. Doing this will force
52 | lite-xl to wait for `fc-match`, which can be much slower.
53 |
54 |
55 | [1]: https://www.freedesktop.org/wiki/Software/fontconfig/
56 | [2]: https://github.com/lite-xl/lite-xl-plugins/blob/master/plugins/fontconfig.lua
57 | [3]: https://github.com/takase1121/mingw-w64-fontconfig
58 | [4]: https://www.freedesktop.org/software/fontconfig/fontconfig-user.html
59 |
--------------------------------------------------------------------------------
/site.rb:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env ruby
2 | require 'redcarpet'
3 | require 'redcarpet/render_strip'
4 | require 'rouge'
5 | require 'json'
6 | require 'fileutils'
7 |
8 | class RedRouge < Redcarpet::Render::HTML
9 | def block_code(code, language)
10 | "" + Rouge.highlight(code, language || "bash", 'html') + "
"
11 | end
12 |
13 | def link(link, title, link_content)
14 | # make all external and asset links to open in new tab
15 | "#{link_content}"
16 | end
17 | end
18 |
19 | class StripMore < Redcarpet::Render::StripDown
20 | def link(link, title, content) content end
21 | end
22 |
23 | def slugify(name)
24 | name
25 | .downcase
26 | .gsub(/[^a-z0-9]+/, "-") # replace non-url friendly characters with dashes
27 | .gsub(/\-+/, "-") # remove duplicate dashes
28 | .gsub(/^\-|\-$/, "") # remove trailing dashes
29 | end
30 |
31 |
32 |
33 | # config options
34 | root = ENV.fetch("SITE_ROOT", "")
35 | domain = ENV.fetch("SITE_DOMAIN", "https://lite-xl.com")
36 | default_locale = ENV.fetch("SITE_LOCALE", "en")
37 | verbose = ENV.key?("VERBOSE")
38 | generateIndex = !ENV.key?("INDEX")
39 |
40 |
41 |
42 | indexFile = []
43 | root = root.gsub(/\/\\$/, "") + "/" unless root == ""
44 | FileUtils.rm_rf(root) unless root == ""
45 | renderer = Redcarpet::Markdown.new(RedRouge.new(with_toc_data: true), { fenced_code_blocks: true, tables: true, footnotes: true })
46 | stripRenderer = Redcarpet::Markdown.new(StripMore, { fenced_code_blocks: true, tables: true, footnotes: true })
47 | files = Dir
48 | .glob("locales/*")
49 | .map { |x| x.gsub("locales/", "") }
50 | .map { |locale|
51 | template = File.read("locales/#{locale}/template.html")
52 | FileUtils.rm_rf(root + locale)
53 |
54 | # process markdown files
55 | files = Dir
56 | .glob("locales/#{locale}/**/*.md")
57 | .select { |x| File.file?(x) }
58 | .map { |path|
59 | basename = path.gsub("locales/#{locale}", "").gsub(/.\w+$/, "")
60 | basepath = path.gsub("locales/#{locale}", "")
61 | original_lang_path = File.expand_path("locales/#{default_locale}/#{basepath}")
62 |
63 | original_newer = begin locale != default_locale && File.mtime(original_lang_path) > File.mtime(path) ? "block" : "none" rescue "none" end
64 | puts("#{original_lang_path} is newer than #{original_lang_path}") if verbose && original_newer == "block"
65 |
66 | # the slugs produced by target and id is different, as target slugifies each component
67 | # while id slugifies everything. For instance, path "/locale/en/magic!I don't know" produces
68 | # target = /en/magic-i-don-t-know
69 | # id = magic-i-don-t-know
70 | target = File.join(Pathname(locale + basename).each_filename.map { |component| slugify(component) }) + ".html"
71 |
72 | FileUtils.mkdir_p(root + File.dirname(target)) unless Dir.exist?(root + File.dirname(target))
73 | mdContent = File.read(path)
74 | contents = renderer.render(mdContent)
75 | title = (contents.scan(/<\s*h1.*?>(.*?)<\s*\/h1\s*>/).first || ["Lite XL"]).first
76 | title = "Lite XL - #{title}" unless title == "Lite XL"
77 | id = slugify(basename)
78 |
79 | contents = template
80 | .gsub("{{ page }}", contents)
81 | .gsub("{{ title }}", title)
82 | .gsub("{{ id }}", id)
83 | .gsub("{{ lang }}", locale)
84 | .gsub("{{ path }}", File.join(Pathname(basename).each_filename.map { |component| component == "index" ? "" : slugify(component) }))
85 | .gsub("{{ original_ver_is_newer }}", original_newer)
86 | File.write(root + target, contents)
87 |
88 | if generateIndex
89 | # this is inflexible; we need to rework this
90 | categories = Pathname(basename).each_filename.map { |component| slugify(component) }
91 | categories.pop
92 | stripContent = stripRenderer
93 | .render(mdContent)
94 | .gsub(/ {2,}/, '\t') # attempt to compact indentation
95 | .gsub(/([\r\n\t\v])+/, '\1') # remove duplicate space
96 | .strip
97 | indexFile.append({
98 | "id" => target,
99 | "title" => title,
100 | "category" => categories,
101 | "content" => stripContent
102 | })
103 | end
104 |
105 |
106 | # return target filename for sitemap
107 | target
108 | }
109 |
110 | # html file passthrough
111 | files + Dir
112 | .glob("locales/#{locale}/**/*.html")
113 | .select { |file| file != "locales/#{locale}/template.html" }
114 | .map { |file| [file, root + file.gsub("locales/", "")] }
115 | .each { |(src, dest)| FileUtils.copy_file(src, dest, true, true) }
116 | .map { |(_, dest)| dest }
117 | }
118 | .flatten
119 | .each { |path| puts("#{path} generated.") if verbose }
120 | .map { |path| "#{domain}/#{path == "index.html" ? '' : path}" }
121 | .unshift(domain) # prepend the domain
122 |
123 | # write sitemap
124 | File.write("#{root}sitemap.txt", files.join("\n") + "\n")
125 |
126 | # generate index file
127 | File.write("#{root}posts.json", JSON.generate(indexFile)) if generateIndex
128 |
129 | # copy index.html for default locale
130 | unless File.symlink?("#{root}index.html")
131 | FileUtils.copy_file("#{root}#{default_locale}/index.html", "#{root}index.html")
132 | end
133 |
134 | # copy other files
135 | unless root == ""
136 | FileUtils.cp_r("assets", "#{root}assets")
137 | FileUtils.copy_file("404.html", "#{root}404.html")
138 | end
139 |
--------------------------------------------------------------------------------
16 | 
126 | 
127 |