comparing d6cc60d6055569aa95e219759c6cbd6cd7eb1a4c and master on hauleth.dev/blog

-4

.gitattributes

···

       1
       -
       *.png filter=lfs diff=lfs merge=lfs -text

     

       2
       -
       *.woff filter=lfs diff=lfs merge=lfs -text

     

       3
       -
       *.jpg filter=lfs diff=lfs merge=lfs -text

     

       4
       -
       *.jpeg filter=lfs diff=lfs merge=lfs -text

+16

.github/workflows/rebuild.yml

···

       1
       +
       name: Trigger Netlify rebuild

     

       2
       +
       on:

     

       3
       +
         schedule:

     

       4
       +
           # Run every 8h

     

       5
       +
           - cron: '0 */8 * * *'

     

       6
       +
       

     

       7
       +
       jobs:

     

       8
       +
         trigger:

     

       9
       +
           name: Send trigger

     

       10
       +
           runs-on: ubuntu-latest

     

       11
       +
           env:

     

       12
       +
             BUILD_HOOK_URL: 'https://api.netlify.com/build_hooks/629f4bdea589057c66219efd'

     

       13
       +
           steps:

     

       14
       +
             - name: Run cURL request

     

       15
       +
               run: |

     

       16
       +
                 curl -X POST -d '{}' "$BUILD_HOOK_URL"

.gitignore

···

       1
        
       node_modules/

     

       2
        
       /public

     

       0
        
       
     

       0
        
       
     

       0

···

       1
        
       node_modules/

     

       2
        
       /public

     

       3
       +
       

     

       4
       +
       # Local Netlify folder

     

       5
       +
       .netlify

-3

.gitmodules

···

       1
       -
       [submodule "themes/zerm"]

     

       2
       -
       	path = themes/zerm

     

       3
       -
       	url = https://github.com/ejmg/zerm.git

.ignore

···

       1
       +
       /static

     

       2
       +
       /styles

.mdlrc

···

       1
       +
       style 'styles/markdown.rb'

     

       2
       +
       

     

       3
       +
       # vi: ft=ruby

.vale.ini

···

       1
       +
       StylesPath = styles

     

       2
       +
       

     

       3
       +
       [*.md]

     

       4
       +
       BasedOnStyles = proselint, write-good

     

       5
       +
       write-good.Passive = NO

     

       6
       +
       write-good.TooWordy = NO

README.md

···

       0

···

       1
       +
       templates/shortcodes/readme.md

+37 -21

config.toml

···

       1
       -
       base_url = "/"

     

       2
        
       default_language = "en"

     

       3
        
       

     

       4
        
       title = "Hauleth's blog"

     

       5
        
       description = "Blog about BEAM, Rust, fantasy & stuff"

     

       0
        
       
     

       0
        
       
     

       6
        
       

     

       7
        
       theme = "zerm"

     

       8
        
       

     

       9
       -
       highlight_code = true

     

       10
       -
       highlight_theme = "nord"

     

       11
       -
       generate_feed = true

     

       12
        
       

     

       13
        
       taxonomies = [

     

       14
       -
         {name = "tags"},

     

       15
       -
         {name = "categories"},

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       16
        
       ]

     

       17
        
       

     

       18
        
       [extra]

     

       19
       -
       author = "Łukasz Niemier"

     

       0
        
       
     

       20
        
       theme_color = "blue"

     

       0
        
       
     

       0
        
       
     

       21
        
       

     

       22
        
       logo_text = "~hauleth"

     

       23
        
       logo_home_link = "/"

     
···

       25
        
       show_author = false

     

       26
        
       show_categories = true

     

       27
        
       show_tags = true

     

       28
       -
       

     

       29
       -
       # How many menu items to show on desktop. if you set this to 0, only submenu

     

       30
       -
       # button will be visible.

     

       31
       -
       show_menu_items = 10

     

       32
        
       

     

       33
        
       # set theme to full screen width.

     

       34
        
       full_width = false

     
···

       40
        
       # Must be placed in root of static/ directory...

     

       41
        
       # og_preview_img = ""

     

       42
        
       

     

       43
       -
       # Copyright notice if desired. Defaults to 

     

       44
       -
       # copyright = "copyright notice here"

     

       45
        
       

     

       46
        
       # Menu items to display. You define a url and the name of the menu item.

     

       47
       -
       # NOTE: `$BASE_URL/` must be included in the url name.

     

       48
        
       main_menu = [

     

       49
       -
         {url="/about/", name="about"},

     

       50
       -
         {url="https://twitter.com/hauleth", name="twitter"},

     

       51
       -
         {url="https://github.com/hauleth", name="github"},

     

       52
       -
         {url="https://gitlab.com/hauleth", name="gitlab"},

     

       0
        
       
     

       53
        
       ]

     

       54
        
       

     

       55
       -
       # Displayed as title of drop-down menu when size of main_menu > show_menu_items.

     

       56
       -
       menu_more = "show more"

     

       57
       -
       

     

       58
        
       # Displayed after teaser text for a blog post.

     

       59
        
       read_more = "read more"

     

       60
        
       

     

       61
        
       # not currently used from previous theme, but leaving here for now in case I

     

       62
        
       # feel like adding it.

     

       63
        
       read_other_posts = "read other posts"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0

···

       1
       +
       base_url = "https://hauleth.dev/"

     

       2
        
       default_language = "en"

     

       3
        
       

     

       4
        
       title = "Hauleth's blog"

     

       5
        
       description = "Blog about BEAM, Rust, fantasy & stuff"

     

       6
       +
       

     

       7
       +
       compile_sass = true

     

       8
        
       

     

       9
        
       theme = "zerm"

     

       10
        
       

     

       11
       +
       generate_feeds = true

     

       12
       +
       minify_html = true

     

       0
        
       
     

       13
        
       

     

       14
        
       taxonomies = [

     

       15
       +
         {name = "tags", feed = true},

     

       16
       +
       ]

     

       17
       +
       

     

       18
       +
       [markdown]

     

       19
       +
       highlight_code = true

     

       20
       +
       highlight_theme = "css"

     

       21
       +
       # TODO: Write custom theme that will fit the overall colouring better

     

       22
       +
       highlight_themes_css = [

     

       23
       +
         { theme = "nord", filename = "syntax-theme.css" },

     

       24
        
       ]

     

       25
        
       

     

       26
        
       [extra]

     

       27
       +
       author = "Hauleth"

     

       28
       +
       for_hire = true

     

       29
        
       theme_color = "blue"

     

       30
       +
       

     

       31
       +
       source = "https://tangled.sh/hauleth.dev/blog"

     

       32
        
       

     

       33
        
       logo_text = "~hauleth"

     

       34
        
       logo_home_link = "/"

     
···

       36
        
       show_author = false

     

       37
        
       show_categories = true

     

       38
        
       show_tags = true

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       39
        
       

     

       40
        
       # set theme to full screen width.

     

       41
        
       full_width = false

     
···

       47
        
       # Must be placed in root of static/ directory...

     

       48
        
       # og_preview_img = ""

     

       49
        
       

     

       50
       +
       copyright = "copyright by <a href=\"https://hauleth.dev\" rel=me>hauleth</a>"

     

       0
        
       
     

       51
        
       

     

       52
        
       # Menu items to display. You define a url and the name of the menu item.

     

       0
        
       
     

       53
        
       main_menu = [

     

       54
       +
         {url="https://plan.cat/~hauleth", name=".plan", rel="me"},

     

       55
       +
         {url="https://fosstodon.org/@hauleth", name="toots", rel="me"},

     

       56
       +
         {url="https://sr.ht/~hauleth", name="sourcehut", rel="me"},

     

       57
       +
         {url="https://github.com/hauleth", name="github", rel="me"},

     

       58
       +
         {url="https://gitlab.com/hauleth", name="gitlab", rel="me"},

     

       59
        
       ]

     

       60
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       61
        
       # Displayed after teaser text for a blog post.

     

       62
        
       read_more = "read more"

     

       63
        
       

     

       64
        
       # not currently used from previous theme, but leaving here for now in case I

     

       65
        
       # feel like adding it.

     

       66
        
       read_other_posts = "read other posts"

     

       67
       +
       

     

       68
       +
       favicon = "favicon-32x32.png"

     

       69
       +
       og_preview_img = "banner.png"

     

       70
       +
       

     

       71
       +
       webmention = "https://webmention.io/hauleth.dev/webmention"

     

       72
       +
       

     

       73
       +
       [extra.twitter]

     

       74
       +
         site = "@hauleth"

     

       75
       +
         creator = "@hauleth"

     

       76
       +
       

     

       77
       +
       [[extra.webrings]]

     

       78
       +
         name = "Beambloggers"

     

       79
       +
         url = "https://beambloggers.com/"

+6 -2

content/_index.md

···

       1
        
       +++

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       2
        
       sort_by = "date"

     

       3
       -
       transparent = false

     

       4
       -
       paginate_by = 3

     

       5
        
       insert_anchor_links = "right"

     

       6
        
       +++

     

       0
        
       
     

       0

···

       1
        
       +++

     

       2
       +
       title = "Hauleth"

     

       3
       +
       template = "landing.html"

     

       4
       +
       

     

       5
        
       sort_by = "date"

     

       6
       +
       paginate_by = 1000

     

       0
        
       
     

       7
        
       insert_anchor_links = "right"

     

       8
        
       +++

     

       9
       +
       

     

       10
       +
       {{ readme() }}

-7

content/about.md

···

       1
       -
       +++

     

       2
       -
       title = "foo"

     

       3
       -
       transparent = false

     

       4
       -
       paginate_by = 0

     

       5
       -
       +++

     

       6
       -
       

     

       7
       -
       Foo

content/cv/_index.md

···

       1
       +
       +++

     

       2
       +
       title = "CV"

     

       3
       +
       

     

       4
       +
       [extra]

     

       5
       +
       no_comments = true

     

       6
       +
       sitemap = false

     

       7
       +
       +++

     

       8
       +
       

     

       9
       +
       {{ cv() }}

+4 -2

content/post/_index.md

···

       1
        
       +++

     

       2
       -
       transparent = true

     

       3
       -
       render = false

     

       4
        
       insert_anchor_links = "right"

     

       0
        
       
     

       0
        
       
     

       5
        
       +++

···

       1
        
       +++

     

       2
       +
       sort_by = "date"

     

       3
       +
       paginate_by = 1000

     

       4
        
       insert_anchor_links = "right"

     

       5
       +
       transparent = true

     

       6
       +
       redirect_to = "/"

     

       7
        
       +++

+472

content/post/beam-process-memory-usage.md

···

       1
       +
       +++

     

       2
       +
       date = 2023-06-10

     

       3
       +
       title = "How much memory is needed to run 1M Erlang processes?"

     

       4
       +
       description = "How to not write benchmarks"

     

       5
       +
       

     

       6
       +
       [taxonomies]

     

       7
       +
       tags = [

     

       8
       +
         "beam",

     

       9
       +
         "performance"

     

       10
       +
       ]

     

       11
       +
       +++

     

       12
       +
       

     

       13
       +
       Recently [benchmark for concurrency implementation in different

     

       14
       +
       languages][benchmark]. In this article [Piotr Kołaczkowski][] used Chat GPT to

     

       15
       +
       generate the examples in the different languages and benchmarked them. This was

     

       16
       +
       poor choice as I have found this article and read the Elixir example:

     

       17
       +
       

     

       18
       +
       [benchmark]: https://pkolaczk.github.io/memory-consumption-of-async/ "How Much Memory Do You Need to Run 1 Million Concurrent Tasks?"

     

       19
       +
       [Piotr Kołaczkowski]: https://github.com/pkolaczk

     

       20
       +
       

     

       21
       +
       ```elixir

     

       22
       +
       tasks =

     

       23
       +
           for _ <- 1..num_tasks do

     

       24
       +
               Task.async(fn ->

     

       25
       +
                   :timer.sleep(10000)

     

       26
       +
               end)

     

       27
       +
           end

     

       28
       +
       

     

       29
       +
       Task.await_many(tasks, :infinity)

     

       30
       +
       ```

     

       31
       +
       

     

       32
       +
       And, well, it's pretty poor example of BEAM's process memory usage, and I am

     

       33
       +
       not talking about the fact that it uses 4 spaces for indentation.

     

       34
       +
       

     

       35
       +
       For 1 million processes this code reported 3.94 GiB of memory used by the process

     

       36
       +
       in Piotr's benchmark, but with little work I managed to reduce it about 4 times

     

       37
       +
       to around 0.93 GiB of RAM usage. In this article I will describe:

     

       38
       +
       

     

       39
       +
       - how I did that

     

       40
       +
       - why the original code was consuming so much memory

     

       41
       +
       - why in the real world you probably should not optimise like I did here

     

       42
       +
       - why using ChatGPT to write benchmarking code sucks (TL;DR because that will

     

       43
       +
         nerd snipe people like me)

     

       44
       +
       

     

       45
       +
       ## What are Erlang processes?

     

       46
       +
       

     

       47
       +
       Erlang is ~~well~~ known of being language which support for concurrency is

     

       48
       +
       superb, and Erlang processes are the main reason for that. But what are these?

     

       49
       +
       

     

       50
       +
       In Erlang *process* is the common name for what other languages call *virtual

     

       51
       +
       threads* or *green threads*, but in Erlang these have small neat twist - each of

     

       52
       +
       the process is isolated from the rest and these processes can communicate only

     

       53
       +
       via message passing. That gives Erlang processes 2 features that are rarely

     

       54
       +
       spotted in other implementations:

     

       55
       +
       

     

       56
       +
       - Failure isolation - bug, unhandled case, or other issue in single process will

     

       57
       +
         not directly affect any other process in the system. VM can send some messages

     

       58
       +
         due to process shutdown, and other processes may be killed because of that,

     

       59
       +
         but by itself shutting down single process will not cause problems in any

     

       60
       +
         process not related to that.

     

       61
       +
       - Location transparency - process can be spawned locally or on different

     

       62
       +
         machine, but from the viewpoint of the programmer, there is no difference.

     

       63
       +
       

     

       64
       +
       The above features and requirements results in some design choices, but for our

     

       65
       +
       purpose only one is truly needed today - each process have separate and (almost)

     

       66
       +
       independent memory stack from any other process.

     

       67
       +
       

     

       68
       +
       ### Process dictionary

     

       69
       +
       

     

       70
       +
       Each process in Erlang VM has dedicated *mutable* memory space for their

     

       71
       +
       internal uses. Most people do not use it for anything because in general it

     

       72
       +
       should not be used unless you know exactly what you are doing (in my case, a bad

     

       73
       +
       carpenter could count cases when I needed it, on single hand). In general it's

     

       74
       +
       *here be dragons* area.

     

       75
       +
       

     

       76
       +
       How it's relevant to us?

     

       77
       +
       

     

       78
       +
       Well, OTP internally uses process dictionary (`pdict` for short) to store

     

       79
       +
       metadata about given process that can be later used for debugging purposes. Some

     

       80
       +
       data that it store are:

     

       81
       +
       

     

       82
       +
       - Initial function that was run by the given process

     

       83
       +
       - PIDs to all ancestors of the given process

     

       84
       +
       

     

       85
       +
       Different processes abstractions (like `gen_server`/`GenServer`, Elixir's

     

       86
       +
       `Task`, etc.) can store even more metadata there, `logger` store process

     

       87
       +
       metadata in process dictionary, `rand` store state of the PRNGs in the process

     

       88
       +
       dictionary. it's used quite extensively by some OTP features.

     

       89
       +
       

     

       90
       +
       ### "Well behaved" OTP process

     

       91
       +
       

     

       92
       +
       In addition to the above metadata if the process is meant to be "well behaved"

     

       93
       +
       process in OTP system, i.e. process that can be observed and debugged using OTP

     

       94
       +
       facilities, it must respond to some additional messages defined by [`sys`][]

     

       95
       +
       module. Without that the features like [`observer`][] would not be able to "see"

     

       96
       +
       the content of the process state.

     

       97
       +
       

     

       98
       +
       [`sys`]: https://erlang.org/doc/man/sys.html

     

       99
       +
       [`observer`]: https://erlang.org/doc/man/observer.html

     

       100
       +
       

     

       101
       +
       ## Process memory usage

     

       102
       +
       

     

       103
       +
       As we have seen above, the `Task.async/1` function form Elixir **must** do

     

       104
       +
       much more than just simple "start process and live with it". That was one of the

     

       105
       +
       most important problems with the original process, it was using system, that was

     

       106
       +
       allocating quite substantial memory alongside of the process itself, just to

     

       107
       +
       operate this process. In general, that would be desirable approach (as you

     

       108
       +
       **really, really, want the debugging facilities**), but in synthetic benchmarks,

     

       109
       +
       it reduce the feasibility of such benchmark.

     

       110
       +
       

     

       111
       +
       If we want to avoid that additional memory overhead in our spawned processes we

     

       112
       +
       need to go back to more primitive functions in Erlang, namely `erlang:spawn/1`

     

       113
       +
       (`Kernel.spawn/1` in Elixir). But that mean that we cannot use

     

       114
       +
       `Task.await_many/2` anymore, so we need to workaround it by using custom

     

       115
       +
       function:

     

       116
       +
       

     

       117
       +
       ```elixir

     

       118
       +
       defmodule Bench do

     

       119
       +
         def await(pid) when is_pid(pid) do

     

       120
       +
           # Monitor is internal feature of Erlang that will inform you (by sending

     

       121
       +
           # message) when process you monitor die. The returned value is type called

     

       122
       +
           # "reference" which is just simply unique value returned by the VM.

     

       123
       +
           # If the process is already dead, then message will be delivered

     

       124
       +
           # immediately.

     

       125
       +
           ref = Process.monitor(pid)

     

       126
       +
       

     

       127
       +
           receive do

     

       128
       +
             {:DOWN, ^ref, :process, _, _} -> :ok

     

       129
       +
           end

     

       130
       +
         end

     

       131
       +
       

     

       132
       +
         def await_many(pids) do

     

       133
       +
           Enum.each(pids, &await/1)

     

       134
       +
         end

     

       135
       +
       end

     

       136
       +
       

     

       137
       +
       tasks =

     

       138
       +
         for _ <- 1..num_tasks do

     

       139
       +
           # `Kernel` module is imported by default, so no need for `Kernel.` prefix

     

       140
       +
           spawn(fn ->

     

       141
       +
             :timer.sleep(10000)

     

       142
       +
           end)

     

       143
       +
         end

     

       144
       +
       

     

       145
       +
       Bench.await_many(tasks)

     

       146
       +
       ```

     

       147
       +
       

     

       148
       +
       We already removed one problem (well, two in fact, but we will go into

     

       149
       +
       details in next section).

     

       150
       +
       

     

       151
       +
       ## All your lists are belongs to us now

     

       152
       +
       

     

       153
       +
       Erlang, like most of the functional programming languages, have 2 built-in

     

       154
       +
       sequence types:

     

       155
       +
       

     

       156
       +
       - Tuples - which are non-growable product type of the values, so you can access

     

       157
       +
         any field quite fast, but adding more values is performance no-no

     

       158
       +
       - (Singly) linked lists - growable type (in most case it will have single type

     

       159
       +
         values in it, but in Erlang that is not always the case), which is fast to

     

       160
       +
         prepend or pop data from the beginning, but do not try to do anything else if

     

       161
       +
         you care about performance.

     

       162
       +
       

     

       163
       +
       In this case we will focus on the 2nd one, as there tuples aren't important at

     

       164
       +
       all.

     

       165
       +
       

     

       166
       +
       Singly linked list is simple data structure. It's either special value `[]`

     

       167
       +
       (an empty list) or it's something called "cons-cell". Cons-cells are also

     

       168
       +
       simple structures - it's 2ary tuple (tuple with 2 elements) where first value

     

       169
       +
       is head - the value in the list cell, and another one is the "tail" of the list (aka

     

       170
       +
       rest of the list). In Elixir the cons-cell is denoted like that `[head | tail]`.

     

       171
       +
       Super simple structure as you can see, and perfect for the functional

     

       172
       +
       programming as you can add new values to the list without modifying existing

     

       173
       +
       values, so you can be immutable and fast. However if you need to construct the

     

       174
       +
       sequence of a lot of values (like our list of all tasks) then we have problem.

     

       175
       +
       Because Elixir promises that list returned from the `for` will be **in-order**

     

       176
       +
       of the values passed to it. That mean that we either need to process our data

     

       177
       +
       like that:

     

       178
       +
       

     

       179
       +
       ```elixir

     

       180
       +
       def map([], _), do: []

     

       181
       +
       

     

       182
       +
       def map([head | tail], func) do

     

       183
       +
         [func.(head) | map(tail, func)]

     

       184
       +
       end

     

       185
       +
       ```

     

       186
       +
       

     

       187
       +
       Where we build call stack (as we cannot have tail call optimisation there, of

     

       188
       +
       course sans compiler optimisations). Or we need to build our list in reverse

     

       189
       +
       order, and then reverse it before returning (so we can have TCO):

     

       190
       +
       

     

       191
       +
       ```elixir

     

       192
       +
       def map(list, func), do: do_map(list, func, [])

     

       193
       +
       

     

       194
       +
       def map([], _func, agg), do: :lists.reverse(agg)

     

       195
       +
       

     

       196
       +
       def map([head | tail], func, agg) do

     

       197
       +
         map(tail, func, [func.(head) | agg])

     

       198
       +
       end

     

       199
       +
       ```

     

       200
       +
       

     

       201
       +
       Which one of these approaches is more performant is irrelevant[^erlang-perf],

     

       202
       +
       what is relevant is that we need either build call stack or construct our list

     

       203
       +
       *twice* to be able to conform to the Elixir promises (even if in this case we do

     

       204
       +
       not care about order of the list returned by the `for`).

     

       205
       +
       

     

       206
       +
       [^erlang-perf]: Sometimes body recursion will be faster, sometimes TCO will be

     

       207
       +
       faster. it's impossible to tell without more benchmarking. For more info check

     

       208
       +
       out [superb article by Ferd Herbert](https://ferd.ca/erlang-s-tail-recursion-is-not-a-silver-bullet.html).

     

       209
       +
       

     

       210
       +
       Of course we could mitigate our problem by using `Enum.reduce/3` function (or

     

       211
       +
       writing it on our own) and end with code like:

     

       212
       +
       

     

       213
       +
       ```elixir

     

       214
       +
       defmodule Bench do

     

       215
       +
         def await(pid) when is_pid(pid) do

     

       216
       +
           ref = Process.monitor(pid)

     

       217
       +
       

     

       218
       +
           receive do

     

       219
       +
             {:DOWN, ^ref, :process, _, _} -> :ok

     

       220
       +
           end

     

       221
       +
         end

     

       222
       +
       

     

       223
       +
         def await_many(pids) do

     

       224
       +
           Enum.each(pids, &await/1)

     

       225
       +
         end

     

       226
       +
       end

     

       227
       +
       

     

       228
       +
       tasks =

     

       229
       +
         Enum.reduce(1..num_tasks, [], fn _, agg ->

     

       230
       +
           # `Kernel` module is imported by default, so no need for `Kernel.` prefix

     

       231
       +
           pid =

     

       232
       +
             spawn(fn -> :timer.sleep(10000) end)

     

       233
       +
       

     

       234
       +
           [pid | agg]

     

       235
       +
         end)

     

       236
       +
       

     

       237
       +
       Bench.await_many(tasks)

     

       238
       +
       ```

     

       239
       +
       

     

       240
       +
       Even then we build list of all PIDs.

     

       241
       +
       

     

       242
       +
       Here I can also go back to the "second problem* I have mentioned above.

     

       243
       +
       `Task.await_many/1` *also construct a list*. it's list of return value from all

     

       244
       +
       the processes in the list, so not only we constructed list for the tasks' PIDs,

     

       245
       +
       we also constructed list of return values (which will be `:ok` for all processes

     

       246
       +
       as it's what `:timer.sleep/1` returns), and immediately discarded all of that.

     

       247
       +
       

     

       248
       +
       How we can better? See that **all** we care is that all `num_task` processes

     

       249
       +
       have gone down. We do not care about any of the return values, all what we want

     

       250
       +
       is to know that all processes that we started went down. For that we can just

     

       251
       +
       send messages from the spawned processes and count the received messages count:

     

       252
       +
       

     

       253
       +
       ```elixir

     

       254
       +
       defmodule Bench do

     

       255
       +
         def worker(parent) do

     

       256
       +
           :timer.sleep(10000)

     

       257
       +
           send(parent, :done)

     

       258
       +
         end

     

       259
       +
       

     

       260
       +
         def start(0), do: :ok

     

       261
       +
         def start(n) when n > 0 do

     

       262
       +
           this = self()

     

       263
       +
           spawn(fn -> worker(this) end)

     

       264
       +
       

     

       265
       +
           start(n - 1)

     

       266
       +
         end

     

       267
       +
       

     

       268
       +
         def await(0), do: :ok

     

       269
       +
         def await(n) when n > 0 do

     

       270
       +
           receive do

     

       271
       +
             :done -> await(n - 1)

     

       272
       +
           end

     

       273
       +
         end

     

       274
       +
       end

     

       275
       +
       

     

       276
       +
       Bench.start(num_tasks)

     

       277
       +
       Bench.await(num_tasks)

     

       278
       +
       ```

     

       279
       +
       

     

       280
       +
       Now we do not have any lists involved and we still do what the original task

     

       281
       +
       meant to do - spawn `num_tasks` processes and wait till all go down.

     

       282
       +
       

     

       283
       +
       ## Arguments copying

     

       284
       +
       

     

       285
       +
       One another thing that we can account there - lambda context and data passing

     

       286
       +
       between processes.

     

       287
       +
       

     

       288
       +
       You see, we need to pass `this` (which is PID of the parent) to our newly

     

       289
       +
       spawned process. That is suboptimal, as we are looking for the way to reduce

     

       290
       +
       amount of the memory (and ignore all other metrics at the same time). As Erlang

     

       291
       +
       processes are meant to be "share nothing" type of processes there is problem -

     

       292
       +
       we need to copy that PID to all processes. it's just 1 word (which mean 8 bytes

     

       293
       +
       on 64-bit architectures, 4 bytes on 32-bit), but hey, we are microbenchmarking,

     

       294
       +
       so we cut whatever we can (with 1M processes, this adds up to 8 MiBs).

     

       295
       +
       

     

       296
       +
       Hey, we can avoid that by using yet another feature of Erlang, called

     

       297
       +
       *registry*. This is yet another simple feature that allows us to assign PID of

     

       298
       +
       the process to the atom, which allows us then to send messages to that process

     

       299
       +
       using just name, we have given. While atoms are also 1 word that wouldn't make

     

       300
       +
       sense to send it as well, but instead we can do what any reasonable

     

       301
       +
       microbenchmarker would do - *hardcode stuff*:

     

       302
       +
       

     

       303
       +
       ```elixir

     

       304
       +
       defmodule Bench do

     

       305
       +
         def worker do

     

       306
       +
           :timer.sleep(10000)

     

       307
       +
           send(:parent, :done)

     

       308
       +
         end

     

       309
       +
       

     

       310
       +
         def start(0), do: :ok

     

       311
       +
         def start(n) when n > 0 do

     

       312
       +
           spawn(fn -> worker() end)

     

       313
       +
       

     

       314
       +
           start(n - 1)

     

       315
       +
         end

     

       316
       +
       

     

       317
       +
         def await(0), do: :ok

     

       318
       +
         def await(n) when n > 0 do

     

       319
       +
           receive do

     

       320
       +
             :done -> await(n - 1)

     

       321
       +
           end

     

       322
       +
         end

     

       323
       +
       end

     

       324
       +
       

     

       325
       +
       Process.register(self(), :parent)

     

       326
       +
       

     

       327
       +
       Bench.start(num_tasks)

     

       328
       +
       Bench.await(num_tasks)

     

       329
       +
       ```

     

       330
       +
       

     

       331
       +
       Now we do not pass any arguments, and instead rely on the registry to dispatch

     

       332
       +
       our messages to respective processes.

     

       333
       +
       

     

       334
       +
       ## One more thing

     

       335
       +
       

     

       336
       +
       As you may have already noticed we are passing lambda to the `spawn/1`. That is

     

       337
       +
       also quite suboptimal, because of [difference between remote and local call][remote-vs-local].

     

       338
       +
       This mean that we are paying slight memory cost for these processes to keep the

     

       339
       +
       old module in memory. Instead we can use either fully qualified function capture

     

       340
       +
       or `spawn/3` function that accepts MFA (module, function name, arguments list)

     

       341
       +
       argument. We end with:

     

       342
       +
       

     

       343
       +
       [remote-vs-local]: https://www.erlang.org/doc/reference_manual/code_loading.html#code-replacement

     

       344
       +
       

     

       345
       +
       ```elixir

     

       346
       +
       defmodule Bench do

     

       347
       +
         def worker do

     

       348
       +
           :timer.sleep(10000)

     

       349
       +
           send(:parent, :done)

     

       350
       +
         end

     

       351
       +
       

     

       352
       +
         def start(0), do: :ok

     

       353
       +
         def start(n) when n > 0 do

     

       354
       +
           spawn(&__MODULE__.worker/0)

     

       355
       +
       

     

       356
       +
           start(n - 1)

     

       357
       +
         end

     

       358
       +
       

     

       359
       +
         def await(0), do: :ok

     

       360
       +
         def await(n) when n > 0 do

     

       361
       +
           receive do

     

       362
       +
             :done -> await(n - 1)

     

       363
       +
           end

     

       364
       +
         end

     

       365
       +
       end

     

       366
       +
       

     

       367
       +
       Process.register(self(), :parent)

     

       368
       +
       

     

       369
       +
       Bench.start(num_tasks)

     

       370
       +
       Bench.await(num_tasks)

     

       371
       +
       ```

     

       372
       +
       

     

       373
       +
       ## Results

     

       374
       +
       

     

       375
       +
       With given Erlang compilation:

     

       376
       +
       

     

       377
       +
       ```txt

     

       378
       +
       Erlang/OTP 25 [erts-13.2.2.1] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1]

     

       379
       +
       

     

       380
       +
       Elixir 1.14.5 (compiled with Erlang/OTP 25)

     

       381
       +
       ```

     

       382
       +
       

     

       383
       +
       > Note no JIT as Nix on macOS currently[^currently] disable it and I didn't bother to enable

     

       384
       +
       > it in the derivation (it was disabled because there were some issues, but IIRC

     

       385
       +
       > these are resolved now).

     

       386
       +
       

     

       387
       +
       [^currently]: Nixpkgs rev `bc3ec5ea`

     

       388
       +
       

     

       389
       +
       The results are as follow (in bytes of peak memory footprint returned by

     

       390
       +
       `/usr/bin/time` on macOS):

     

       391
       +
       

     

       392
       +
       | Implementation |       1k |      100k |         1M |

     

       393
       +
       | -------------- | -------: | --------: | ---------: |

     

       394
       +
       | Original       | 45047808 | 452837376 | 4227715072 |

     

       395
       +
       | Spawn          | 43728896 | 318230528 | 2869723136 |

     

       396
       +
       | Reduce         | 43552768 | 314798080 | 2849304576 |

     

       397
       +
       | Count          | 43732992 | 313507840 | 2780540928 |

     

       398
       +
       | Registry       | 44453888 | 311988224 | 2787237888 |

     

       399
       +
       | RemoteCall     | 43597824 | 310595584 | 2771525632 |

     

       400
       +
       

     

       401
       +
       As we can see we have reduced the memory use by about 30% by just changing

     

       402
       +
       from `Task.async/1` to `spawn/1`. Further optimisations reduced memory usage

     

       403
       +
       slightly, but with no such drastic changes.

     

       404
       +
       

     

       405
       +
       Can we do better?

     

       406
       +
       

     

       407
       +
       Well, with some VM flags tinkering - of course.

     

       408
       +
       

     

       409
       +
       You see, by default Erlang VM will not only create some data required for

     

       410
       +
       handling process itself[^word]:

     

       411
       +
       

     

       412
       +
       [^word]: Again, word here mean 8 bytes on 64-bit and 4 bytes on 32-bit architectures.

     

       413
       +
       

     

       414
       +
       > | Data Type | Memory Size |

     

       415
       +
       > | - | - |

     

       416
       +
       > | … | … |

     

       417
       +
       > | Erlang process | 338 words when spawned, including a heap of 233 words. |

     

       418
       +
       >

     

       419
       +
       > -- [Erlang Efficiency Guide: 11. Advanced](https://erlang.org/doc/efficiency_guide/advanced.html#Advanced)

     

       420
       +
       

     

       421
       +
       As we can see, there are 105 words that are required and 233 words which are

     

       422
       +
       used for preallocated heap. But this is microbenchmarking, so as we do not need

     

       423
       +
       that much of memory (because our processes basically does nothing), we can

     

       424
       +
       reduce it. We do not care about time performance anyway. For that we can use

     

       425
       +
       `+hms` flag and set it to some small value, for example `1`.

     

       426
       +
       

     

       427
       +
       In addition to heap size Erlang by default load some additional data from the

     

       428
       +
       BEAM files. That data is used for debugging and error reporting, but again, we

     

       429
       +
       are microbenchmarking, and who need debugging support anyway (answer: everyone,

     

       430
       +
       so **do not** do it in production). Luckily for us, the VM has yet another flag

     

       431
       +
       for that purpose `+L`.

     

       432
       +
       

     

       433
       +
       Erlang also uses some [ETS][] (Erlang Term Storage) tables by default (for

     

       434
       +
       example to support process registry we have mentioned above). ETS tables can be

     

       435
       +
       compressed, but by default it's not done, as it can slow down some kinds of

     

       436
       +
       operations on such tables. Fortunately there is, another, flag `+ec` that has

     

       437
       +
       description:

     

       438
       +
       

     

       439
       +
       > Forces option compressed on all ETS tables. Only intended for test and

     

       440
       +
       > evaluation.

     

       441
       +
       

     

       442
       +
       [ETS]: https://erlang.org/doc/man/ets.html

     

       443
       +
       

     

       444
       +
       Sounds good enough for me.

     

       445
       +
       

     

       446
       +
       With all these flags enabled we get peak memory footprint at 996257792 bytes.

     

       447
       +
       

     

       448
       +
       Compare it in more human readable units.

     

       449
       +
       

     

       450
       +
       |                          | Peak Memory Footprint for 1M processes |

     

       451
       +
       | ------------------------ | -------------------------------------- |

     

       452
       +
       | Original code            | 3.94 GiB                               |

     

       453
       +
       | Improved code            | 2.58 GiB                               |

     

       454
       +
       | Improved code with flags | 0.93 GiB                               |

     

       455
       +
       

     

       456
       +
       Result - about 76% of the peak memory usage reduction. Not bad.

     

       457
       +
       

     

       458
       +
       ## Summary

     

       459
       +
       

     

       460
       +
       First of all:

     

       461
       +
       

     

       462
       +
       > Please, do not use ChatGPT for writing code for microbenchmarks.

     

       463
       +
       

     

       464
       +
       The thing about *micro*benchmarking is that we write code that does as little as

     

       465
       +
       possible to show (mostly) meaningless features of the given technology in

     

       466
       +
       abstract environment. ChatGPT cannot do that, not out of malice or incompetence,

     

       467
       +
       but because it used (mostly) *good* and idiomatic code to teach itself,

     

       468
       +
       microbenchmarks rarely are something that people will consider to have these

     

       469
       +
       qualities. It also cannot consider other features that [wetware][] can take into

     

       470
       +
       account (like our "we do not need lists there" thing).

     

       471
       +
       

     

       472
       +
       [wetware]: https://en.wikipedia.org/wiki/Wetware_(brain)

+10 -15

content/post/common-test-for-elixir.md

···

       4
        
       

     

       5
        
       [taxonomies]

     

       6
        
       tags = [

     

       7
       -
        "erlang",

     

       8
        
        "beam",

     

       9
       -
        "elixir",

     

       10
       -
        "testing",

     

       11
       -
        "programming",

     

       12
       -
        "common_test",

     

       13
       -
        "commoner"

     

       14
        
       ]

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       15
        
       +++

     

       16
        
       

     

       17
        
       In my new job I have opportunity to work a little bit more with Erlang code and

     
···

       104
        
       

     

       105
        
       Just check [this out](/common-test-example/simple/index.html). This is example report

     

       106
        
       generated by the Common Test. As you can see it contains a lot of information in

     

       107
       -
       quite readable format. Not only it contains informations about current run, but

     

       108
        
       all previous runs as well, which is really handy when tracking regressions.

     

       109
        
       

     

       110
       -
       But can we store even more informations there? Yes, as CT includes simple

     

       111
       -
       logging facility it is completely possible to log your own informations during

     

       112
       -
       tests, for example, lets modify our test to log some informations:

     

       113
        
       

     

       114
        
       ```erlang

     

       115
        
       test_function_name(_Config) ->

     
···

       117
        
           2 = 1 + 1.

     

       118
        
       ```

     

       119
        
       

     

       120
       -
       Now when we run tests again, then we will see more informations (even coloured)

     

       121
        
       in [our test log](/common-test-example/log/ct_run.ct@NiunioBook.2019-07-16_11.03.21/common-test-example.log.logs/run.2019-07-16_11.03.22/example_suite.test_function_name.html):

     

       122
        
       

     

       123
        
       ![Common Test log "Example message" on green background](/img/common-test/log.png)

     
···

       170
        
       

     

       171
        
       - On [Elixir forum thread about Commoner][forum]

     

       172
        
       - On Twitter via `@hauleth`

     

       173
       -
       

     

       174
       -
       ### Special thanks

     

       175
       -
       

     

       176
       -
       - José Valim - for reading it through and reviewing before publishing

     

       177
        
       

     

       178
        
       [ct]: http://erlang.org/doc/apps/common_test/basics_chapter.html

     

       179
        
       [ctex]: https://github.com/Comcast/ctex

···

       4
        
       

     

       5
        
       [taxonomies]

     

       6
        
       tags = [

     

       0
        
       
     

       7
        
        "beam",

     

       8
       +
        "testing"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       9
        
       ]

     

       10
       +
       

     

       11
       +
       [[extra.thanks]]

     

       12
       +
       name = "José Valim"

     

       13
       +
       why = "for reading it through and reviewing before publishing"

     

       14
        
       +++

     

       15
        
       

     

       16
        
       In my new job I have opportunity to work a little bit more with Erlang code and

     
···

       103
        
       

     

       104
        
       Just check [this out](/common-test-example/simple/index.html). This is example report

     

       105
        
       generated by the Common Test. As you can see it contains a lot of information in

     

       106
       +
       quite readable format. Not only it contains information about current run, but

     

       107
        
       all previous runs as well, which is really handy when tracking regressions.

     

       108
        
       

     

       109
       +
       But can we store even more information there? Yes, as CT includes simple

     

       110
       +
       logging facility it is completely possible to log your own information during

     

       111
       +
       tests, for example, lets modify our test to log some information:

     

       112
        
       

     

       113
        
       ```erlang

     

       114
        
       test_function_name(_Config) ->

     
···

       116
        
           2 = 1 + 1.

     

       117
        
       ```

     

       118
        
       

     

       119
       +
       Now when we run tests again, then we will see more information (even coloured)

     

       120
        
       in [our test log](/common-test-example/log/ct_run.ct@NiunioBook.2019-07-16_11.03.21/common-test-example.log.logs/run.2019-07-16_11.03.22/example_suite.test_function_name.html):

     

       121
        
       

     

       122
        
       ![Common Test log "Example message" on green background](/img/common-test/log.png)

     
···

       169
        
       

     

       170
        
       - On [Elixir forum thread about Commoner][forum]

     

       171
        
       - On Twitter via `@hauleth`

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       172
        
       

     

       173
        
       [ct]: http://erlang.org/doc/apps/common_test/basics_chapter.html

     

       174
        
       [ctex]: https://github.com/Comcast/ctex

+1 -5

content/post/eli5-ownership.md

···

       5
        
       

     

       6
        
       [taxonomies]

     

       7
        
       tags = [

     

       8
       -
         "rust",

     

       9
       -
         "programming",

     

       10
       -
         "ownership",

     

       11
       -
         "eli5",

     

       12
       -
         "borrowing"

     

       13
        
       ]

     

       14
        
       +++

     

       15

···

       5
        
       

     

       6
        
       [taxonomies]

     

       7
        
       tags = [

     

       8
       +
         "rust"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       9
        
       ]

     

       10
        
       +++

     

       11

+1 -4

content/post/elixir-application.md

···

       8
        
       

     

       9
        
       [taxonomies]

     

       10
        
       tags = [

     

       11
       -
         "elixir",

     

       12
       -
         "erlang",

     

       13
       -
         "beam",

     

       14
       -
         "programming"

     

       15
        
       ]

     

       16
        
       +++

     

       17

···

       8
        
       

     

       9
        
       [taxonomies]

     

       10
        
       tags = [

     

       11
       +
         "beam"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       12
        
       ]

     

       13
        
       +++

     

       14

-59

content/post/erlang-in-mix.md

···

       1
       -
       +++

     

       2
       -
       title = "Erlang in Mix"

     

       3
       -
       date = 2019-07-24T12:32:07+02:00

     

       4
       -
       draft = true

     

       5
       -
       +++

     

       6
       -
       

     

       7
       -
       Currently there are 3 main build tools in BEAM world:

     

       8
       -
       

     

       9
       -
       - Rebar3 - de facto standard in Erlang and other languages (with exception to

     

       10
       -
         Elixir). Uses declarative `rebar.config` file (which is in `file:consult/1`

     

       11
       -
         format) that can be then formatted via `rebar.config.script` Erlang script.

     

       12
       -
       - Mix - standard build tool in Elixir world. Uses imperative `mix.exs` file.

     

       13
       -
       - erlang.mk - GNU Make based tool. Uses it's own registry and is mostly known as

     

       14
       -
         tool used by Cowboy.

     

       15
       -
       

     

       16
       -
       In this article I will cover only first two and their comparison when it comes

     

       17
       -
       to support building mostly Erlang projects (AFAIK `rebar3` do not have yet

     

       18
       -
       support for building Elixir projects, mostly because Elixir cannot be used as

     

       19
       -
       Erlang library).

     

       20
       -
       

     

       21
       -
       ## Declarative vs imperative

     

       22
       -
       

     

       23
       -
       Accordingly to [Wikipedia][declarative programming]:

     

       24
       -
       

     

       25
       -
       > In computer science, declarative programming is a programming paradigm—a style

     

       26
       -
       > of building the structure and elements of computer programs—that expresses the

     

       27
       -
       > logic of a computation without describing its control flow.

     

       28
       -
       

     

       29
       -
       In other words, we only describe **what** without focusing on **how**. This mean

     

       30
       -
       that we have less direct control over our configuration while requiring less

     

       31
       -
       knowledge to configure properly.

     

       32
       -
       

     

       33
       -
       At the same time it is (in theory) more secure, as imagine that you would have

     

       34
       -
       dependency with such `mix.exs`:

     

       35
       -
       

     

       36
       -
       ```elixir

     

       37
       -
       defmodule TotallySafeLibrary.Mixfile do

     

       38
       -
         use Mix.Project

     

       39
       -
       

     

       40
       -
         # HAHAHA I lied!!! Pwnd MF

     

       41
       -
         File.rm_rf!(System.user_home())

     

       42
       -
       

     

       43
       -
         # …

     

       44
       -
       end

     

       45
       -
       ```

     

       46
       -
       

     

       47
       -
       I mean, this is still possible in Rebar via `rebar.config.script`, but it is

     

       48
       -
       much harder due to 2 reasons:

     

       49
       -
       

     

       50
       -
       - There is no such function like `File.rm_rf!/1` in Erlang, so the end user

     

       51
       -
         would need to write their own.

     

       52
       -
       - It is much easier to spot additional file in the repo than review whole one

     

       53
       -
         file.

     

       54
       -
       

     

       55
       -
       The same goes for `.app.src` file, which while having more "abstract" format

     

       56
       -
       than Mix's `application/0` function ends much simpler without all imperativeness

     

       57
       -
       brought by making configuration file executable script.

     

       58
       -
       

     

       59
       -
       ## Tasks

content/post/indie-web.md

···

       1
       +
       +++

     

       2
       +
       title = "IndieWeb"

     

       3
       +
       date = 2022-06-08T11:25:55+00:00

     

       4
       +
       draft = true

     

       5
       +
       

     

       6
       +
       [taxonomies]

     

       7
       +
       tags = []

     

       8
       +
       +++

+71

content/post/jeopardy-world.md

···

       1
       +
       +++

     

       2
       +
       title = "Jeopardy! world"

     

       3
       +
       date = 2025-07-28

     

       4
       +
       

     

       5
       +
       [taxonomies]

     

       6
       +
       tags = ["ai", "culture"]

     

       7
       +
       +++

     

       8
       +
       

     

       9
       +
       Some time ago, there was an anime available on Netflix — *Godzilla Singular

     

       10
       +
       Point*. It wasn't a spectacular success, but it featured a plot device that I

     

       11
       +
       think reflects something increasingly common today: you need to know the answer

     

       12
       +
       to your question before you can ask it.

     

       13
       +
       

     

       14
       +
       This is something I see all the time in the current wave of AI hype. You need to

     

       15
       +
       know what the answer *should* be before you can write a useful prompt.

     

       16
       +
       

     

       17
       +
       <!-- more -->

     

       18
       +
       

     

       19
       +
       The issue I have with many AI use cases is this: unless you have specialized

     

       20
       +
       knowledge about the topic you're asking about, you can't reliably tell the

     

       21
       +
       difference between a solid AI answer and complete nonsense.

     

       22
       +
       

     

       23
       +
       I've had a few discussions about this on various Discord servers. The example I

     

       24
       +
       often use is this simple question posed to an AI:

     

       25
       +
       

     

       26
       +
       > Does 6 character long identification number, that contains digits and upper

     

       27
       +
       > case letters (with exception to 0, O, 1, I, and L) is enough to randomly

     

       28
       +
       > assign unique identification numbers for 10 million records?

     

       29
       +
       

     

       30
       +
       You can see for your self answer from ChatGPT [there][chatgpt].

     

       31
       +
       

     

       32
       +
       At first glance, the answer looks valid and sensible. The math checks out. It

     

       33
       +
       calculates the number of available combinations correctly. Everything seems

     

       34
       +
       *fine*.

     

       35
       +
       

     

       36
       +
       **BUT…**

     

       37
       +
       

     

       38
       +
       There is huge issue there, and probably most of the people who have been working

     

       39
       +
       with basic statistic or cryptography will notice it. ChatGPT (and any other AI

     

       40
       +
       that I have tested out) fail to notice very important word there

     

       41
       +
       

     

       42
       +
       > \[…] randomly \[…]

     

       43
       +
       

     

       44
       +
       This single word invalidates the entire reasoning, despite the correct

     

       45
       +
       calculations. Because of the [birthday problem][], the answer isn't feasible.

     

       46
       +
       While it's technically possible to assign a unique ID to every record, doing so

     

       47
       +
       randomly introduces a high probability of collisions.

     

       48
       +
       

     

       49
       +
       - At around 35,000 generated IDs, there's already a 50% chance of a collision

     

       50
       +
       - At around 90,000, the chance of at least one duplicate reaches 99%

     

       51
       +
       

     

       52
       +
       So even though the math is correct, the logic fails under the randomness constraint.

     

       53
       +
       

     

       54
       +
       ## *Jeopardy!* world

     

       55
       +
       

     

       56
       +
       This is my main issue with AI tools: if you already have knowledge about the

     

       57
       +
       subject, you don’t really need to ask the AI. But if you don’t have that

     

       58
       +
       knowledge, you have no reliable way of knowing whether the answer makes sense or

     

       59
       +
       not. It’s like playing *Jeopardy!* — you need to know the answer before you can

     

       60
       +
       phrase the right question.

     

       61
       +
       

     

       62
       +
       In my view, AI is most useful in areas where the results can be quickly reviewed

     

       63
       +
       and discarded if needed. That’s why the whole “vibe coding” (aka slop

     

       64
       +
       generation) approach falls short. If you don’t have a good sense of what the

     

       65
       +
       output should look like, you probably don’t have the expertise to verify it.

     

       66
       +
       

     

       67
       +
       [And gods forbid you from allowing AI to do anything on production][replit-fuckup].

     

       68
       +
       

     

       69
       +
       [chatgpt]: https://chatgpt.com/share/68879fe7-d4e0-8007-9a30-3a9e2ace791d

     

       70
       +
       [birthday problem]: https://en.wikipedia.org/wiki/Birthday_problem

     

       71
       +
       [replit-fuckup]: https://www.businessinsider.com/replit-ceo-apologizes-ai-coding-tool-delete-company-database-2025-7?op=1

+482

content/post/log-all-the-things.md

···

       1
       +
       +++

     

       2
       +
       title = "Log all the things"

     

       3
       +
       date = 2022-01-02

     

       4
       +
       

     

       5
       +
       [taxonomies]

     

       6
       +
       tags = [

     

       7
       +
         "beam",

     

       8
       +
         "observability"

     

       9
       +
       ]

     

       10
       +
       

     

       11
       +
       [[extra.thanks]]

     

       12
       +
       name = "Kai Wern Choong"

     

       13
       +
       +++

     

       14
       +
       

     

       15
       +
       In Elixir 1.11 landed set of new features that allows for more powerful logging

     

       16
       +
       by utilising Erlang's [`logger`][erl-log] features. Here I will try to describe

     

       17
       +
       new possibilities and how You can use them to improve your logs.

     

       18
       +
       

     

       19
       +
       <!-- more -->

     

       20
       +
       

     

       21
       +
       ## New log levels {#levels}

     

       22
       +
       

     

       23
       +
       Elixir gained 4 new log levels to total 8 (from most verbose to least verbose):

     

       24
       +
       

     

       25
       +
       - debug

     

       26
       +
       - info

     

       27
       +
       - **notice** *

     

       28
       +
       - warning (renamed from warn)

     

       29
       +
       - error

     

       30
       +
       - **critical** *

     

       31
       +
       - **alert** *

     

       32
       +
       - **emergency** *

     

       33
       +
       

     

       34
       +
       <small>* new levels</small>

     

       35
       +
       

     

       36
       +
       This allow to provide finer graded verbosity control, due to compatibility

     

       37
       +
       reasons, in Elixir backends we need to translate these levels back to "old" set

     

       38
       +
       of 4. The current table looks like:

     

       39
       +
       

     

       40
       +
       | Call level            | What Elixir backend will see |

     

       41
       +
       | --                    | --                           |

     

       42
       +
       | `debug`               | `debug`                      |

     

       43
       +
       | `info`                | `info`                       |

     

       44
       +
       | `notice`              | **`info`** *                 |

     

       45
       +
       | `warning` (or `warn`) | `warn`                       |

     

       46
       +
       | `error`               | `error`                      |

     

       47
       +
       | `critical`            | **`error`** *                |

     

       48
       +
       | `alert`               | **`error`** *                |

     

       49
       +
       | `emergency`           | **`error`** *                |

     

       50
       +
       

     

       51
       +
       <small>* "translated" messages</small>

     

       52
       +
       

     

       53
       +
       We can set verbosity to all levels. This may be confusing during the transition

     

       54
       +
       period, but we cannot change the behaviour until Elixir 2 (which is not

     

       55
       +
       happening any time soon).

     

       56
       +
       

     

       57
       +
       Usage of the new levels is "obvious":

     

       58
       +
       

     

       59
       +
       ```elixir

     

       60
       +
       Logger.notice("Hello")

     

       61
       +
       ```

     

       62
       +
       

     

       63
       +
       Will produce message with `notice` level of verbosity.

     

       64
       +
       

     

       65
       +
       Additionally the `logger.level` option in configuration supports 2 additional

     

       66
       +
       verbosity levels that you can use in your config:

     

       67
       +
       

     

       68
       +
       - `:all` - all messages will be logged, logically exactly the same as `:debug`

     

       69
       +
       - `:none` - no messages will be logged

     

       70
       +
       

     

       71
       +
       ## Per module log level {#per-module-level}

     

       72
       +
       

     

       73
       +
       This is change that can be quite handy during debugging sessions. With this

     

       74
       +
       change we have 4 new functions in `Logger` module:

     

       75
       +
       

     

       76
       +
       - [`get_module_level/1`](https://hexdocs.pm/logger/Logger.html#get_module_level/1)

     

       77
       +
       - [`put_module_level/2`](https://hexdocs.pm/logger/Logger.html#put_module_level/2)

     

       78
       +
       - [`delete_module_level/1`](https://hexdocs.pm/logger/Logger.html#delete_module_level/1)

     

       79
       +
       - [`delete_all_module_level/0`](https://hexdocs.pm/logger/Logger.html#delete_all_module_level/0)

     

       80
       +
       

     

       81
       +
       These allow us to manipulate verbosity level on per-module basis. What is

     

       82
       +
       non-obvious and is super handy is that it allows both lowering **and raising**

     

       83
       +
       verbosity for given module. This mean that:

     

       84
       +
       

     

       85
       +
       ```elixir

     

       86
       +
       require Logger

     

       87
       +
       

     

       88
       +
       Logger.configure(level: :error)

     

       89
       +
       

     

       90
       +
       defmodule Foo do

     

       91
       +
         def run do

     

       92
       +
           Logger.debug("I am still there")

     

       93
       +
         end

     

       94
       +
       end

     

       95
       +
       

     

       96
       +
       Foo.run() # Does not log anything

     

       97
       +
       

     

       98
       +
       # Set `debug` level for `Foo` module only

     

       99
       +
       Logger.put_module_level(Foo, :debug)

     

       100
       +
       Foo.run()

     

       101
       +
       # `I am still there` is logged

     

       102
       +
       Logger.debug("I will not be printed")

     

       103
       +
       # Nothing got logged as top-level verbositi is still set to `:error`

     

       104
       +
       ```

     

       105
       +
       

     

       106
       +
       Of course it will not work if you decide to use [compile time purging][logger-purge]

     

       107
       +
       

     

       108
       +
       ## Logger handlers {#handlers}

     

       109
       +
       

     

       110
       +
       ---

     

       111
       +
       

     

       112
       +
       **Warning!** This is not fully implemented in both - Erlang and Elixir. Writing

     

       113
       +
       your own handlers without additional knowledge can cause overload problems.

     

       114
       +
       

     

       115
       +
       ---

     

       116
       +
       

     

       117
       +
       Erlang together with their logging implementation needed to provide a way to

     

       118
       +
       ingest these logs somehow. This is done via Erlang logger handlers (in this

     

       119
       +
       article called *handlers* in contrast to Elixir backends called *backends*

     

       120
       +
       there).

     

       121
       +
       

     

       122
       +
       Handlers are modules that export at least 1 function `log/2` that takes 2

     

       123
       +
       arguments:

     

       124
       +
       

     

       125
       +
       - `log_event` which is a map with 3 fields:

     

       126
       +
         - `:level` - verbosity level

     

       127
       +
         - `:msg` - tuple describing message:

     

       128
       +
           - `{:io.format(), [term()]}` - format string and list of terms that should

     

       129
       +
             be passed to `:io_lib.format/2` function

     

       130
       +
           - `{:report, map() | keyword()}` - report that can be formatted into string

     

       131
       +
             by `report_cb/{1,2}` set in metadata map (see below)

     

       132
       +
           - `{:string, :unicode.chardata()}` - raw string that should be printed as

     

       133
       +
             a message

     

       134
       +
         - `:meta` - map containing all metadata for given event. All keys should be

     

       135
       +
           atoms and values can be anything. Some keys have special meaning, and some

     

       136
       +
           of them will be populated automatically by the `Logger` macros and functions.

     

       137
       +
           These are:

     

       138
       +
           - `:pid` - PID of the process that fired log event

     

       139
       +
           - `:gl` - group leader of the process that fired log event

     

       140
       +
           - `:mfa` - tuple in form of `{module(), name :: atom(), arity :: non_neg_integer()}`

     

       141
       +
             that describe function that fired log event

     

       142
       +
           - `:file` - filename of file that defines the code that fired log event

     

       143
       +
           - `:line` - line in the given file where the log event was fired

     

       144
       +
           - `:domain` - list of atoms that can be used to describe log events

     

       145
       +
             hierarchy which then can be used for filtering. All events fired using

     

       146
       +
             `Logger` macros and functions will have `:elixir` prepended to their

     

       147
       +
             domain list.

     

       148
       +
           - `:report_cb` - function that will be used to format `{:report, map() |

     

       149
       +
             keyword()}` messages. This can be either 1-ary function, that takes report

     

       150
       +
             and returns `{:io.format(), [term()]}` leaving truncation and further

     

       151
       +
             formatting up to the main formatter, or 2-ary function that takes report

     

       152
       +
             and configuration map `%{depth: pos_integer() | :unlimited, chars_limit:

     

       153
       +
             pos_integer() | :unlimited, single_line: boolean()}` and returns already

     

       154
       +
             formatted `:unicode.chardata()`. More about it can be found in [separate

     

       155
       +
             section](#structured-logging).

     

       156
       +
       

     

       157
       +
       Return value of this function is ignored. If there will be any exception raised

     

       158
       +
       when calling this function, then it will be captured and failing handler will be

     

       159
       +
       removed. This is important, as if such handler is the only one, then you can be

     

       160
       +
       left without any logging handler and miss logs.

     

       161
       +
       

     

       162
       +
       The important thing about Erlang handlers and Elixir backends is that Erlang

     

       163
       +
       handlers functions are called **within caller process** while Elixir backends

     

       164
       +
       are called in separate process. This mean that wrongly written Erlang handler

     

       165
       +
       can cause quite substantial load on application.

     

       166
       +
       

     

       167
       +
       To read on other, optional, callbacks that can be defined by Erlang handler, that

     

       168
       +
       will not be covered there, I suggest looking into [Erlang documentation][formatter_cb].

     

       169
       +
       

     

       170
       +
       ## Structured logging {#structured-logging}

     

       171
       +
       

     

       172
       +
       One of the biggest new features in the Elixir 1.11 is support for structured

     

       173
       +
       logging. This mean that the log message do not need to be free-form string, but

     

       174
       +
       instead we can pass structure, that can provide more machine-readable data for

     

       175
       +
       processing in log aggregators. In Elixir 1.11 is simple as passing map as a

     

       176
       +
       first argument to the `Logger` macros:

     

       177
       +
       

     

       178
       +
       ```elixir

     

       179
       +
       Logger.info(%{

     

       180
       +
         status: :completed,

     

       181
       +
         response: :ok

     

       182
       +
       })

     

       183
       +
       ```

     

       184
       +
       

     

       185
       +
       This will produce message that looks like:

     

       186
       +
       

     

       187
       +
       ```log

     

       188
       +
       14:08:46.849 [info]  [response: :ok, status: :completed]

     

       189
       +
       ```

     

       190
       +
       

     

       191
       +
       As we can see, the map (called *report*) is formatted as a keyword list. This is

     

       192
       +
       default way to present the report data. Unfortunately we cannot access the

     

       193
       +
       metadata from the Elixir backends, but we have 2 ways to make these messages

     

       194
       +
       more readable for the human operator:

     

       195
       +
       

     

       196
       +
       1. Utilise [`Logger`'s translators](https://hexdocs.pm/logger/Logger.Translator.html)

     

       197
       +
       1. Using `:report_cb` field in metadata

     

       198
       +
       

     

       199
       +
       1st option is described quite good in Elixir documentation and is available

     

       200
       +
       since Elixir 1.0 as it was used to translate `error_logger` messages in old

     

       201
       +
       Erlang versions. Here I will describe the 2nd option which provide way for

     

       202
       +
       **caller** to define how report should be formatted into human-readable string.

     

       203
       +
       

     

       204
       +
       `:report_cb` accepts 2 kind of functions as an argument:

     

       205
       +
       

     

       206
       +
       - 1-ary function, that takes report as an argument and should return tuple

     

       207
       +
         in form of `{:io.format(), [term()]}` that will be later formatted

     

       208
       +
         respectively by the formatters.

     

       209
       +
       - 2-ary function that takes report and configuration map as an arguments and

     

       210
       +
         should return formatted string.

     

       211
       +
       

     

       212
       +
       1st option is much easier for most use cases, as it do not force you to worry

     

       213
       +
       about handling width, depth, and multiline logs, as it will all be handled for

     

       214
       +
       you.

     

       215
       +
       

     

       216
       +
       For example, instead of doing:

     

       217
       +
       

     

       218
       +
       ```elixir

     

       219
       +
       Logger.info("Started HTTP server on http://localhost:8080")

     

       220
       +
       ```

     

       221
       +
       

     

       222
       +
       We can do:

     

       223
       +
       

     

       224
       +
       ```elixir

     

       225
       +
       Logger.info(

     

       226
       +
         %{

     

       227
       +
           protocol: :http,

     

       228
       +
           port: 8080,

     

       229
       +
           address: "localhost",

     

       230
       +
           endpoint: MyEndpoint,

     

       231
       +
           handler: Plug.Cowboy

     

       232
       +
         },

     

       233
       +
         report_cb: &__MODULE__.report_cb/1

     

       234
       +
       )

     

       235
       +
       

     

       236
       +
       # …

     

       237
       +
       

     

       238
       +
       def report_cb(%{protocol: protocol, port: port, address: address}) do

     

       239
       +
         {"Started ~s server on ~s://~s:~B", [protocol, protocol, address, port]}

     

       240
       +
       end

     

       241
       +
       ```

     

       242
       +
       

     

       243
       +
       While the second entry seems much more verbose, with proper handler, it can

     

       244
       +
       provide much more detailed output. Just imagine that we would have handler that

     

       245
       +
       output JSON data and what information we could contain in such message:

     

       246
       +
       

     

       247
       +
       ```json

     

       248
       +
       {

     

       249
       +
         "msg": "Started HTTP server on http://localhost:8080",

     

       250
       +
         "metadata": {

     

       251
       +
           "mfa": "MyMod.start/2",

     

       252
       +
           "file": "foo.ex",

     

       253
       +
           "line": 42

     

       254
       +
         }

     

       255
       +
       }

     

       256
       +
       ```

     

       257
       +
       

     

       258
       +
       Now our log aggregation service need to parse `msg` field to extract all

     

       259
       +
       information that is contained there, like port, address, and protocol. With

     

       260
       +
       structured logging we can have that message available already there while

     

       261
       +
       presenting the "human readable" form as well:

     

       262
       +
       

     

       263
       +
       ```json

     

       264
       +
       {

     

       265
       +
         "text": "Started HTTP server on http://localhost:8080",

     

       266
       +
         "msg": {

     

       267
       +
           "address": "localhost",

     

       268
       +
           "port": 8080,

     

       269
       +
           "protocol": "http",

     

       270
       +
           "endpoint": "MyEndpoint",

     

       271
       +
           "handler": "Plug.Cowboy"

     

       272
       +
         },

     

       273
       +
         "metadata": {

     

       274
       +
           "mfa": "MyMod.start/2",

     

       275
       +
           "file": "foo.ex",

     

       276
       +
           "line": 42

     

       277
       +
         }

     

       278
       +
       }

     

       279
       +
       ```

     

       280
       +
       

     

       281
       +
       You can see there that we can have more information available in the structured

     

       282
       +
       log that would otherwise needed to be crammed somewhere into the text message,

     

       283
       +
       even if it is not important in "regular" Ops observability.

     

       284
       +
       

     

       285
       +
       This can raise a question - why not use metadata for such functionality, like it

     

       286
       +
       is available in [`LoggerJSON`][] or [`Ink`][]? The reason is that their reason

     

       287
       +
       existence is different. Metadata meant for "meta" stuff like location, tracing

     

       288
       +
       ID, but not for the information about the message itself. It is best shown on

     

       289
       +
       example. For this use Elixir's implementation of `GenServer` wrapper that

     

       290
       +
       produces error log entry on unknown message handled by default `handle_info/2`:

     

       291
       +
       

     

       292
       +
       ```elixir

     

       293
       +
       Logger.error(

     

       294
       +
         # Report

     

       295
       +
         %{

     

       296
       +
           label: {GenServer, :no_handle_info},

     

       297
       +
           report: %{

     

       298
       +
             module: __MODULE__,

     

       299
       +
             message: msg,

     

       300
       +
             name: proc

     

       301
       +
           }

     

       302
       +
         },

     

       303
       +
         # Metadata

     

       304
       +
         %{

     

       305
       +
           error_logger: %{tag: :error_msg},

     

       306
       +
           report_cb: &GenServer.format_report/1

     

       307
       +
         }

     

       308
       +
       )

     

       309
       +
       ```

     

       310
       +
       

     

       311
       +
       As we can see there, the report contains information like:

     

       312
       +
       

     

       313
       +
       - `:label` - that describes type of the event

     

       314
       +
       - `:report` - content of the "main" event

     

       315
       +
         - `:module` - module that created the event, it is important to notice, that

     

       316
       +
           it is also present in metadata (as part of `:mfa` key), but their meaning is

     

       317
       +
           different. Module name here is meant for the operator to know the name of

     

       318
       +
           the implementor that failed to handle message, while `:mfa` is meant to

     

       319
       +
           describe the location of the code that fired the event.

     

       320
       +
         - `:message` - the message itself that hasn't been handled. Notice, that it is

     

       321
       +
           not stringified in any way there, it is simply passed "as is" to the

     

       322
       +
           report. It is meant to be stringified later by the `:report_cb` function.

     

       323
       +
         - `:name` - name of the process. Remember, similarly to `:module`, the PID of

     

       324
       +
           the current process is part of the metadata, so in theory we could use value

     

       325
       +
           from there, but their meaning is different (additionally this one may be an

     

       326
       +
           atom in case if the process is locally registered with name).

     

       327
       +
       

     

       328
       +
       Metadata on the other hand contains information that will be useful for

     

       329
       +
       filtering or formatting of the event.

     

       330
       +
       

     

       331
       +
       The rule of thumb you can follow is:

     

       332
       +
       

     

       333
       +
       > If it is thing that you will want to filter on, then it probably should be

     

       334
       +
       > part of the metadata. If you want to aggregate information or just display

     

       335
       +
       > them, it should be part of the message report.

     

       336
       +
       

     

       337
       +
       ## Log filtering

     

       338
       +
       

     

       339
       +
       Finally we come to first feature that is not directly accessible from the Elixir

     

       340
       +
       `Logger` API (yet). Erlang's `logger` have powerful functionality for filtering

     

       341
       +
       log messages which allows us to dynamically decide which message should, or

     

       342
       +
       should not be logged. These even can alter messages on the fly.

     

       343
       +
       

     

       344
       +
       Currently that functionality is available only via `:logger` module. It can be

     

       345
       +
       used like:

     

       346
       +
       

     

       347
       +
       ```elixir

     

       348
       +
       defmodule MyFilter do

     

       349
       +
         def filter(log_event, opts) do

     

       350
       +
           # …

     

       351
       +
         end

     

       352
       +
       end

     

       353
       +
       

     

       354
       +
       :logger.add_primary_filter(:my_filter, {&MyFilter.filter/2, opts})

     

       355
       +
       # Or

     

       356
       +
       :logger.add_handler_filter(handler_id, :my_filter, {&MyFilter.filter/2, opts})

     

       357
       +
       ```

     

       358
       +
       

     

       359
       +
       Few important things that need to be remembered when writing such filters:

     

       360
       +
       

     

       361
       +
       - It is best practice to make such functions public and define filters using

     

       362
       +
         remote function capture, like `&__MODULE__.process_disabled/2` (so not

     

       363
       +
         anonymous functions either). It will make such filter much easier for VM to

     

       364
       +
         handle (it is bigger topic why it is that, I may to cover it in another post).

     

       365
       +
       - Filters are ran **within the same process that fired log event**, so it is

     

       366
       +
         important to make such filters as fast as possible, and do not do any heavy

     

       367
       +
         work there.

     

       368
       +
       

     

       369
       +
       Filters can be used for 2 different things:

     

       370
       +
       

     

       371
       +
       - preventing some messages from being logged

     

       372
       +
       - modifying a message

     

       373
       +
       

     

       374
       +
       While the former is much more common, I will try to describe both use cases

     

       375
       +
       there, as the latter is also quite useful.

     

       376
       +
       

     

       377
       +
       Filters are defined as 2-ary functions where 1st argument is log event, and

     

       378
       +
       second argument is any term that can be used as a configuration for filter.

     

       379
       +
       Filter should return one of these 3 values:

     

       380
       +
       

     

       381
       +
       - `:stop` - which will immediately discard message and do not run any additional

     

       382
       +
         filters.

     

       383
       +
       - `:ignore` - which mean that given filter didn't recognise the given message

     

       384
       +
         and leaves it up to other filters to decide on the action. If all filters

     

       385
       +
         return `:ignore` then `:filter_default` option for the handler will be taken.

     

       386
       +
         By default it is `:log`, which mean that message will be logged, but default

     

       387
       +
         handler has it set to `:stop` by default, which mean, that non-matching

     

       388
       +
         messages will be discarded.

     

       389
       +
       - Just log event (possibly modified) that will cause next filter to be called

     

       390
       +
         with altered message. The message returned by the last filter (or in case of

     

       391
       +
         `:ignore` return, previous filters) will be the message passed to handler.

     

       392
       +
       

     

       393
       +
       ### Preventing some messages from being logged

     

       394
       +
       

     

       395
       +
       Most common use-case for filters will probably be rejecting messages that aren't

     

       396
       +
       important for us. [Erlang even prepared some useful filters][logger_filters]:

     

       397
       +
       

     

       398
       +
       - `domain` - allow filtering by metadata `:domain` field (remember as I said

     

       399
       +
         that metadata is for filtering?). It supports multiple possible relations

     

       400
       +
         between the log domain and defined domain.

     

       401
       +
       - `level` - allow filtering (in or out) messages depending on their level, in

     

       402
       +
         both directions. It will allow you to filter messages with higher level for

     

       403
       +
         some handlers. Just remember, that it will not receive messages that will not

     

       404
       +
         pass primary/module level.

     

       405
       +
       - `progress` - filters all reports from `supervisor` and

     

       406
       +
         `application_controller`. Simply, reduces startup/process shutdown chatter

     

       407
       +
         that often is meaningless for most time.

     

       408
       +
       - `remote_gl` - filters messages coming from group leader on another node.

     

       409
       +
         Useful when you want to discard/log messages coming from other nodes in

     

       410
       +
         cluster.

     

       411
       +
       

     

       412
       +
       ### Modifying a message

     

       413
       +
       

     

       414
       +
       Sometimes there is need to alter messages in the system. For example we may need

     

       415
       +
       to prevent sensitive information from being logged. When using "old" Elixir

     

       416
       +
       approach you could abuse translators, but that was error prone, as first

     

       417
       +
       successful translator was breaking pipeline, so you couldn't just smash one on

     

       418
       +
       top and then keep rest working as is. With "new" approach and structured logging

     

       419
       +
       you can just traverse the report and replace all occurrences of the unsafe data

     

       420
       +
       with anonymised data. For example:

     

       421
       +
       

     

       422
       +
       ```elixir

     

       423
       +
       def filter_out_password(%{msg: {:report, report}} = event, _opts) do

     

       424
       +
         %{event | msg: {:report, replace(report)}}

     

       425
       +
       end

     

       426
       +
       

     

       427
       +
       @filtered "[FILTERED]"

     

       428
       +
       

     

       429
       +
       defp replace(%{password: _} = map) do

     

       430
       +
         for {k, v} <- %{map | password: @filtered}, into: %{} do

     

       431
       +
           {k, replace(v)}

     

       432
       +
         end

     

       433
       +
       end

     

       434
       +
       

     

       435
       +
       defp replace(%{"password" => _} = map) do

     

       436
       +
         for {k, v} <- %{map | "password" => @filtered}, into: %{} do

     

       437
       +
           {k, replace(v)}

     

       438
       +
         end

     

       439
       +
       end

     

       440
       +
       

     

       441
       +
       defp replace(list) when is_list(list) do

     

       442
       +
         for elem <- list do

     

       443
       +
           case elem do

     

       444
       +
             {:password, _} -> {:password, @filtered}

     

       445
       +
             {"password", _} -> {"password", @filtered}

     

       446
       +
             {k, v} -> {k, replace(v)}

     

       447
       +
             other -> replace(other)

     

       448
       +
           end

     

       449
       +
         end

     

       450
       +
       end

     

       451
       +
       

     

       452
       +
       defp replace(other), do: other

     

       453
       +
       ```

     

       454
       +
       

     

       455
       +
       This snippet will replace all occurrences of `:password` or `"password"` with

     

       456
       +
       filtered out value.

     

       457
       +
       

     

       458
       +
       The disadvantage of such approach - it will make all messages with such fields

     

       459
       +
       allowed in case if your filter has `:filter_default` set to `:stop`. That mean,

     

       460
       +
       that if you want to make some of them rejected anyway, then you will need to

     

       461
       +
       manually add additional step to reject messages that do not fit into your

     

       462
       +
       patterns. Alternatively you can use `filter_default: :log` and then use opt-out

     

       463
       +
       logging. There currently is no way to alter the message and make other filters

     

       464
       +
       decide whether log it or not (as of OTP 24).

     

       465
       +
       

     

       466
       +
       ## Summary

     

       467
       +
       

     

       468
       +
       New features and possibilities with relation to logging in Elixir 1.11 can be

     

       469
       +
       overwhelming. Fortunately all of the new features are optional and provided in

     

       470
       +
       addition to "good 'ol `Logger.info("logging")`". But for the people who works on

     

       471
       +
       the observability in BEAM (EEF Observability WG, Sentry, Logflare, etc.) it

     

       472
       +
       brings a lot of new powerful capabilities.

     

       473
       +
       

     

       474
       +
       I am thrilled to see what will people create using all that power.

     

       475
       +
       

     

       476
       +
       [erl-log]: https://erlang.org/doc/man/logger.html

     

       477
       +
       [syslog]: https://en.wikipedia.org/wiki/Syslog#Severity_level

     

       478
       +
       [`LoggerJSON`]: https://github.com/Nebo15/logger_json

     

       479
       +
       [`Ink`]: https://hex.pm/packages/ink

     

       480
       +
       [logger_filters]: https://erlang.org/doc/man/logger_filters.html

     

       481
       +
       [logger-purge]: https://hexdocs.pm/logger/Logger.html#module-application-configuration

     

       482
       +
       [formatter_cb]: https://erlang.org/doc/man/logger.html#formatter-callback-functions

-1

content/post/stop-spreading-crap-at-my-home.md

···

       4
        
       

     

       5
        
       [taxonomies]

     

       6
        
       tags = [

     

       7
       -
         "programming",

     

       8
        
         "culture"

     

       9
        
       ]

     

       10
        
       +++

···

       4
        
       

     

       5
        
       [taxonomies]

     

       6
        
       tags = [

     

       0
        
       
     

       7
        
         "culture"

     

       8
        
       ]

     

       9
        
       +++

-2

content/post/treachery-of-representation.md

···

       8
        
       

     

       9
        
       [taxonomies]

     

       10
        
       tags = [

     

       11
       -
         "programming",

     

       12
       -
         "linguistic",

     

       13
        
         "culture"

     

       14
        
       ]

     

       15
        
       +++

···

       8
        
       

     

       9
        
       [taxonomies]

     

       10
        
       tags = [

     

       0
        
       
     

       0
        
       
     

       11
        
         "culture"

     

       12
        
       ]

     

       13
        
       +++

+2 -5

content/post/vim-for-elixir.md

···

       5
        
       

     

       6
        
       [taxonomies]

     

       7
        
       tags = [

     

       8
       -
         "elixir",

     

       9
       -
         "erlang",

     

       10
       -
         "vim",

     

       11
       -
         "neovim",

     

       12
       -
         "programming"

     

       13
        
       ]

     

       14
        
       +++

     

       15

···

       5
        
       

     

       6
        
       [taxonomies]

     

       7
        
       tags = [

     

       8
       +
         "beam",

     

       9
       +
         "vim"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       10
        
       ]

     

       11
        
       +++

     

       12

+511

content/post/who-watches-watchmen-i.md

···

       1
       +
       +++

     

       2
       +
       title = "Who Watches Watchmen? - Part 1"

     

       3
       +
       date = 2022-01-17T21:22:18+01:00

     

       4
       +
       

     

       5
       +
       description = """

     

       6
       +
       A lot of application use systems like Kubernetes for their deployment. In my

     

       7
       +
       humble opinion it is often overkill as system, that offers most of the stuff such

     

       8
       +
       thing provide, is already present in your OS. In this article I will try to

     

       9
       +
       present how to utilise the most popular system supervisor from Elixir

     

       10
       +
       applications.

     

       11
       +
       """

     

       12
       +
       

     

       13
       +
       [taxonomies]

     

       14
       +
       tags = [

     

       15
       +
         "beam",

     

       16
       +
         "systemd"

     

       17
       +
       ]

     

       18
       +
       +++

     

       19
       +
       

     

       20
       +
       I gave talk about this topic on CODE Beam V Americas, but I wasn't really

     

       21
       +
       satisfied with it. In this post I will try to describe what my presentation was

     

       22
       +
       meant to be about.

     

       23
       +
       

     

       24
       +
       If you are wondering about the presentation, [the slides are on SpeakerDeck][slides].

     

       25
       +
       

     

       26
       +
       [slides]: https://speakerdeck.com/hauleth/who-supervises-supervisors

     

       27
       +
       

     

       28
       +
       ## Abstract

     

       29
       +
       

     

       30
       +
       Most of the operating systems are multi-process and multi-user operating

     

       31
       +
       systems. This has a lot of positive aspects, like to be able to do more than one

     

       32
       +
       thing at the time at our devices, but it introduces a lot of complexities that

     

       33
       +
       in most cases are hidden from the users and developers. These things still need

     

       34
       +
       to be handled in one or another way. The most basic problems are:

     

       35
       +
       

     

       36
       +
       - some processes need to be started before user can interact with the OS

     

       37
       +
         in meaningful (for them) way (for example mounting filesystems, logging,

     

       38
       +
         etc.)

     

       39
       +
       - some processes require strict startup ordering, for example you may need

     

       40
       +
         logging to be started before starting HTTP server

     

       41
       +
       - system operator somehow need to know when the process is ready to do their

     

       42
       +
         work, which is often some time after process start

     

       43
       +
       - system operator should be able to check process state in case when debugging

     

       44
       +
         is needed, most commonly via logs

     

       45
       +
       - shutdown of the processes should be handled in a way, that will allow other

     

       46
       +
         processes to be shut down cleanly (for example application that uses DB should

     

       47
       +
         be down before DB itself)

     

       48
       +
       

     

       49
       +
       ## Why we need system supervisor?

     

       50
       +
       

     

       51
       +
       System supervisor is a process started early in the OS boot, that should handle

     

       52
       +
       starting and managing all other processes that will be run on our system. It is

     

       53
       +
       often the init process (first process started by the OS that is running with PID

     

       54
       +
       1\) or it is first (and sometimes only) process started by the init process.

     

       55
       +
       Popular examples of such supervisors (often integrated with init systems):

     

       56
       +
       

     

       57
       +
       - SysV which is "traditional" implementation that originates at UNIX System

     

       58
       +
         V (hence the name)

     

       59
       +
       - BSD init that with some variations is used in BSD-based OSes (NetBSD,

     

       60
       +
         FreeBSD), it shares some similarities to SysV init and services description is

     

       61
       +
         provided by shell scripts

     

       62
       +
       - OpenRC that also uses shell-based scripts for service description, used by

     

       63
       +
         Linux distributions like Gentoo or Alpine

     

       64
       +
       - `launchd` that is used on Darwin (macOS, iPadOS, iOS, watchOS) systems that uses

     

       65
       +
         XML-based `plists` for services description

     

       66
       +
       - `runit` which is small init and supervisor, but quite capable, for example

     

       67
       +
         used by Void Linux

     

       68
       +
       - Upstart created by Canonical Ltd. as a replacement for SysV-like init system

     

       69
       +
         in Ubuntu (no longer in use in Ubuntu), still used in some distributions like

     

       70
       +
         ChromeOS or Synology NAS

     

       71
       +
       - `systemd` (this is the name, not "SystemD") that was created by Red Hat

     

       72
       +
         employee, (in)famous Lennart Poettering, and later was adopted by almost all

     

       73
       +
         major Linux distributions which spawned some heated discussion about it

     

       74
       +
       

     

       75
       +
       In this article I will focus on systemd, and its approach to "new-style system

     

       76
       +
       daemons".

     

       77
       +
       

     

       78
       +
       ---

     

       79
       +
       

     

       80
       +
       **DISCLAIMER**

     

       81
       +
       

     

       82
       +
       Each of the solutions mentioned above has its strong and weak points. I do not

     

       83
       +
       want to start another flame war whether it is good or not. It has some good in

     

       84
       +
       it, and it has some bad in it, but we can say that it "won" over the most used

     

       85
       +
       distributions, and despite our love or hate towards it, we need to learn how to

     

       86
       +
       live with that.

     

       87
       +
       

     

       88
       +
       ---

     

       89
       +
       

     

       90
       +
       ## Why `systemd`?

     

       91
       +
       

     

       92
       +
       `systemd` became a thing because SysV approach to ordering services' startup was

     

       93
       +
       mildly irritating and non-parallelizable. In short, SysV is starting processes

     

       94
       +
       exactly in lexicographical order of files in given directory. This meant, that

     

       95
       +
       even if your service didn't need the DB at all, but it somehow ended further in

     

       96
       +
       the directory listing, you ended in waiting for the DB startup. Additionally,

     

       97
       +
       SysV wasn't really monitoring services, it just assumed that when process forked

     

       98
       +
       itself to the background, then it is "done" with the startup, and we can

     

       99
       +
       continue. This is obviously not true in many cases, for example, if your

     

       100
       +
       previous shutdown wasn't clean because of power shortage or other issue, then

     

       101
       +
       your DB probably need a bit of time to rebuild state from journal. This causes

     

       102
       +
       even more slowdown for the processes further in the list. This is highly

     

       103
       +
       undesired in modern, cloud-based, environment, where you can often start the

     

       104
       +
       machines on-demand during autoscaling actions. When there is a spike in the

     

       105
       +
       traffic that need autoscaling, then the sooner new machine is in usable state

     

       106
       +
       the sooner it can take load from other machines.

     

       107
       +
       

     

       108
       +
       Different tools take different approach to solve that issue there. `systemd`

     

       109
       +
       take approach that is derived from `launchd` - do not do stuff, that is not

     

       110
       +
       needed. We can trigger on action of other services (obviously), but also on

     

       111
       +
       stuff like socket activity, path creation/modification, mounts, connection or

     

       112
       +
       disconnection of device, time events, etc.

     

       113
       +
       

     

       114
       +
       ---

     

       115
       +
       

     

       116
       +
       **DIGRESSION**

     

       117
       +
       

     

       118
       +
       This is exactly the reason why `systemd` has its infamous "feature creep", it

     

       119
       +
       doesn't "digest" all services like Cron or `udev`. It is not that these are

     

       120
       +
       "tightly" intertwined into `systemd`. You can still replace them with their

     

       121
       +
       older counterparts, you will just lose all the features these bring with them.

     

       122
       +
       

     

       123
       +
       ---

     

       124
       +
       

     

       125
       +
       Such lazy approach sometimes require changes into the service itself. For

     

       126
       +
       example to let supervisor know, that you are ready (not just started), you need

     

       127
       +
       some way to communicate with supervisor. In `systemd` you can do so via UNIX

     

       128
       +
       socket pointed by `NOTIFY_SOCKET` environment variable passed to your

     

       129
       +
       application. With the same socket you can implement another useful feature

     

       130
       +
       \- watchdog/heartbeat process. This mean that if for any reason your process

     

       131
       +
       became non-responsive (but it will refuse to die), then supervisor will

     

       132
       +
       forcefully bring process down and restart it, assuming that the error was

     

       133
       +
       accidental.

     

       134
       +
       

     

       135
       +
       About restarting, we can define behaviour of service after main process die. It

     

       136
       +
       can be restarted regardless of the exit code, it can be restarted on abnormal

     

       137
       +
       exit, it can remain shut, etc. Does this ring a bell? This works similarly to

     

       138
       +
       OTP supervisors, but "one level above". If your service utilize system

     

       139
       +
       supervisor right, you can make your application almost ultimately self-healing

     

       140
       +
       (by restarts).

     

       141
       +
       

     

       142
       +
       ## Basic setup

     

       143
       +
       

     

       144
       +
       Now, when we know a little about how and why `systemd` works as it works, we

     

       145
       +
       now can go to details on how to utilize that with services in Elixir.

     

       146
       +
       

     

       147
       +
       As a base we will implement super simple Plug application:

     

       148
       +
       

     

       149
       +
       ```elixir

     

       150
       +
       # hello/application.ex

     

       151
       +
       defmodule Hello.Application do

     

       152
       +
         use Application

     

       153
       +
       

     

       154
       +
         def start(_type, _opts) do

     

       155
       +
           children = [

     

       156
       +
             {Plug.Cowboy, [scheme: :http, plug: Hello.Router] ++ cowboy_opts()},

     

       157
       +
             {Plug.Cowboy.Drainer, refs: :all}

     

       158
       +
           ]

     

       159
       +
       

     

       160
       +
           Supervisor.start_link(children, strategy: :one_for_one)

     

       161
       +
         end

     

       162
       +
       

     

       163
       +
         defp cowboy_opts do

     

       164
       +
           [

     

       165
       +
             port: String.to_integer(System.get_env("PORT", "4000"))

     

       166
       +
           ]

     

       167
       +
         end

     

       168
       +
       end

     

       169
       +
       ```

     

       170
       +
       

     

       171
       +
       ```elixir

     

       172
       +
       # hello/router.ex

     

       173
       +
       defmodule Hello.Router do

     

       174
       +
         use Plug.Router

     

       175
       +
       

     

       176
       +
         plug :match

     

       177
       +
         plug :dispatch

     

       178
       +
       

     

       179
       +
         get "/" do

     

       180
       +
           send_resp(conn, 200, "Hello World!")

     

       181
       +
         end

     

       182
       +
       end

     

       183
       +
       ```

     

       184
       +
       

     

       185
       +
       I will also assume that we are using [Mix release][mix-release] named `hello`

     

       186
       +
       that we later copy to `/opt/hello`.

     

       187
       +
       

     

       188
       +
       [mix-release]: https://hexdocs.pm/mix/Mix.Tasks.Release.html

     

       189
       +
       

     

       190
       +
       ### systemd unit file

     

       191
       +
       

     

       192
       +
       We have only one thing left, we need to define our [`hello.service`][systemd.service]:

     

       193
       +
       

     

       194
       +
       ```ini

     

       195
       +
       [Unit]

     

       196
       +
       Description=Hello World service

     

       197
       +
       

     

       198
       +
       [Service]

     

       199
       +
       Environment=PORT=80

     

       200
       +
       ExecStart=/opt/hello/bin/hello start

     

       201
       +
       ```

     

       202
       +
       

     

       203
       +
       Now you can create file with that content in

     

       204
       +
       `/usr/local/lib/systemd/system/hello.service` and then start it with:

     

       205
       +
       

     

       206
       +
       ```

     

       207
       +
       # systemctl start hello.service

     

       208
       +
       ```

     

       209
       +
       

     

       210
       +
       This is the simplest service imaginable, however from the start we have few

     

       211
       +
       issues there:

     

       212
       +
       

     

       213
       +
       - It will run service as user running supervisor, so if it is run using global

     

       214
       +
         supervisor, then it will run as `root`. You do not want to run anything as

     

       215
       +
         `root`.

     

       216
       +
       - On error it will produce (BEAM) core dump, which may contain sensitive data.

     

       217
       +
       - It can read (and, due to being run as `root`, write) everything in the system,

     

       218
       +
         like private data of other processes.

     

       219
       +
       

     

       220
       +
       [systemd.service]: https://www.freedesktop.org/software/systemd/man/systemd.service.html#

     

       221
       +
       

     

       222
       +
       ## Service readiness

     

       223
       +
       

     

       224
       +
       Erlang VM isn't really the best tool out there wrt the startup times. In

     

       225
       +
       addition to that our application may need some preparation steps before it can

     

       226
       +
       be marked as "ready". This is problem that I sometimes encounter in Docker,

     

       227
       +
       where some containers do not really have any health check, and then I need to

     

       228
       +
       have loop with check in some of the containers that depend on another one. This

     

       229
       +
       "workaround" is frustrating, error prone, and can cause nasty Heisenbugs when

     

       230
       +
       the timing will be wrong.

     

       231
       +
       

     

       232
       +
       Two possible solutions for this problem are:

     

       233
       +
       

     

       234
       +
       - Readiness probe - another program that is ran after the main process is

     

       235
       +
         started, that checks whether our application is ready to work.

     

       236
       +
       - Notification system where our application uses some common protocol to inform

     

       237
       +
         the supervisor that it finished setup and is ready for work.

     

       238
       +
       

     

       239
       +
       systemd supports the second approach via [`sd_notify`][sd_notify]. The approach

     

       240
       +
       there is simple - we have `NOTIFY_SOCKET` environment variable that contain path

     

       241
       +
       to the Unix datagram socket, that we can use to send information about state of

     

       242
       +
       our application. This socket accept set of different messages, but right now,

     

       243
       +
       for our purposes, we will focus only on few of them:

     

       244
       +
       

     

       245
       +
       - `READY=1` - marks our service as ready, aka it is ready to do its work (for

     

       246
       +
         example accept incoming HTTP connections in our example). It need to be sent

     

       247
       +
         within given timespan after start of the VM, otherwise the process will be

     

       248
       +
         killed and possibly restarted

     

       249
       +
       - `STATUS=name` - sets status of our application that can be checked via

     

       250
       +
         `systemctl status hello.service`, this allows us to have better insight into

     

       251
       +
         what is the high level state without manually traversing through logs

     

       252
       +
       - `RELOADING=1` - marks, that our application is reloading, which in general may

     

       253
       +
         mean a lot of things, but there it will be used to mark `:init.restart/0`-like

     

       254
       +
         behaviour (due to [erlang/otp#4698][] there is wrapper for that function in

     

       255
       +
         `systemd` library). The process need then to send `READY=1` within given

     

       256
       +
         timespan, or the process will be marked as a malfunctioning, and will be

     

       257
       +
         forcefully killed and possibly restarted

     

       258
       +
       - `STOPPING=1` - marks, that our application began shutting down process, and

     

       259
       +
         will be closing soon. If the process will not close within given timespan, it

     

       260
       +
         will be forcefully killed

     

       261
       +
       

     

       262
       +
       These messages provide us enough power to not only mark the service as ready,

     

       263
       +
       but also provides additional information about system state, so even operator,

     

       264
       +
       who knows a little about Erlang or our application runtime, will be able to

     

       265
       +
       understand what is going on.

     

       266
       +
       

     

       267
       +
       The main thing is that systemd will wait with activation of the dependants of

     

       268
       +
       our system as well as the `systemctl start` and `systemctl restart` commands

     

       269
       +
       will wait until our service declare that it is ready.

     

       270
       +
       

     

       271
       +
       Usage of such feature is quite simple:

     

       272
       +
       

     

       273
       +
       ```ini

     

       274
       +
       [Unit]

     

       275
       +
       Description=Hello World service

     

       276
       +
       

     

       277
       +
       [Service]

     

       278
       +
       # Define `Type=` to `notify`

     

       279
       +
       Type=notify

     

       280
       +
       Environment=PORT=80

     

       281
       +
       ExecStart=/opt/hello/bin/hello start

     

       282
       +
       WatchdogSec=1min

     

       283
       +
       ```

     

       284
       +
       

     

       285
       +
       And then in our supervisor tree we need add `:systemd.ready()` **after** last

     

       286
       +
       process needed for proper functioning of our application, in our simple example

     

       287
       +
       it is after `Plug.Cowboy`:

     

       288
       +
       

     

       289
       +
       ```elixir

     

       290
       +
       # hello/application.ex

     

       291
       +
       defmodule Hello.Application do

     

       292
       +
         use Application

     

       293
       +
       

     

       294
       +
         def start(_type, _opts) do

     

       295
       +
           children = [

     

       296
       +
             {Plug.Cowboy, [scheme: :http, plug: Hello.Router] ++ cowboy_opts()},

     

       297
       +
             :systemd.ready(), # <-- it is function call, as it returns proper

     

       298
       +
                               # `child_spec/0`

     

       299
       +
             {Plug.Cowboy.Drainer, refs: :all}

     

       300
       +
           ]

     

       301
       +
       

     

       302
       +
           Supervisor.start_link(children, strategy: :one_for_one)

     

       303
       +
         end

     

       304
       +
       

     

       305
       +
         defp cowboy_opts do

     

       306
       +
           [

     

       307
       +
             port: String.to_integer(System.get_env("PORT", "4000"))

     

       308
       +
           ]

     

       309
       +
         end

     

       310
       +
       end

     

       311
       +
       ```

     

       312
       +
       

     

       313
       +
       Now restarting our service will not finish immediately, but will wait until our

     

       314
       +
       service will declare that it is ready.

     

       315
       +
       

     

       316
       +
       ```

     

       317
       +
       # systemctl restart hello.service

     

       318
       +
       ```

     

       319
       +
       

     

       320
       +
       About `STOPPING=1` - the magic thing is that the `systemd` library takes care of

     

       321
       +
       it for you. As soon as the system will be scheduled to shutdown this message

     

       322
       +
       will be automatically sent, and the operator will be notified about this fact.

     

       323
       +
       

     

       324
       +
       We can also provide more information about state of our application. As you may

     

       325
       +
       have already noticed, we have [`Plug.Cowboy.Drainer`][] there. It is process that

     

       326
       +
       will delay shutdown of our application while there are still open connections.

     

       327
       +
       This can take some time, so it would be handy if the operator would see that the

     

       328
       +
       draining is in progress. We can easily achieve that by again changing our

     

       329
       +
       supervision tree to:

     

       330
       +
       

     

       331
       +
       ```elixir

     

       332
       +
       # hello/application.ex

     

       333
       +
       defmodule Hello.Application do

     

       334
       +
         use Application

     

       335
       +
       

     

       336
       +
         def start(_type, _opts) do

     

       337
       +
           children = [

     

       338
       +
             {Plug.Cowboy, [scheme: :http, plug: Hello.Router] ++ cowboy_opts()},

     

       339
       +
             :systemd.ready(),

     

       340
       +
             :systemd.set_status(down: [status: "drained"]),

     

       341
       +
             {Plug.Cowboy.Drainer, refs: :all, shutdown: 10_000},

     

       342
       +
             :systemd.set_status(down: [status: "draining"])

     

       343
       +
           ]

     

       344
       +
       

     

       345
       +
           Supervisor.start_link(children, strategy: :one_for_one)

     

       346
       +
         end

     

       347
       +
       

     

       348
       +
         defp cowboy_opts do

     

       349
       +
           [

     

       350
       +
             port: String.to_integer(System.get_env("PORT", "4000"))

     

       351
       +
           ]

     

       352
       +
         end

     

       353
       +
       end

     

       354
       +
       ```

     

       355
       +
       

     

       356
       +
       Now when we will shutdown our application by:

     

       357
       +
       

     

       358
       +
       ```

     

       359
       +
       # systemctl stop hello.service

     

       360
       +
       ```

     

       361
       +
       

     

       362
       +
       And we have some connections open to our service (you can simulate that with

     

       363
       +
       `wrk`) then when we ran `systemctl status hello.service` in separate terminal

     

       364
       +
       (previous will be blocked until our service shuts down) then you will be able to

     

       365
       +
       see something like:

     

       366
       +
       

     

       367
       +
       ```

     

       368
       +
       ● hello.service - Example Plug application

     

       369
       +
            Loaded: loaded (/usr/local/lib/systemd/system/hello.service; static; vendor preset: enabled)

     

       370
       +
                 Active: deactivating (stop-sigterm) since Sat 2022-01-15 17:46:30 CET;

     

       371
       +
                 1s ago

     

       372
       +
                 Main PID: 1327 (beam.smp)

     

       373
       +
                 Status: "draining"

     

       374
       +
                 Tasks: 19 (limit: 1136)

     

       375
       +
                 Memory: 106.5M

     

       376
       +
       ```

     

       377
       +
       

     

       378
       +
       You can notice that the `Status` is set to `"draining"`. As soon as all

     

       379
       +
       connections will be drained it will change to `"drained"` and then the

     

       380
       +
       application will shut down and service will be marked as `inactive`.

     

       381
       +
       

     

       382
       +
       [sd_notify]: https://www.freedesktop.org/software/systemd/man/sd_notify.html

     

       383
       +
       [erlang/otp#4698]: https://github.com/erlang/otp/issues/4698

     

       384
       +
       [`Plug.Cowboy.Drainer`]: https://hexdocs.pm/plug_cowboy/2.5.2/Plug.Cowboy.Drainer.html

     

       385
       +
       

     

       386
       +
       ## Watchdog

     

       387
       +
       

     

       388
       +
       Watchdog allows us to monitor our application for responsiveness (as mentioned

     

       389
       +
       above). It is simple feature that requires our application to ping systemd

     

       390
       +
       within specified interval, otherwise the application will be forcibly shut down

     

       391
       +
       as malfunctioning. Fortunately for us, the `systemd` library that provides our

     

       392
       +
       integration, have that feature out of the box, so all we need to do to achieve

     

       393
       +
       expected result is set `WatchdogSec=` option in our `systemd.service` file:

     

       394
       +
       

     

       395
       +
       ```ini

     

       396
       +
       [Unit]

     

       397
       +
       Description=Hello World service

     

       398
       +
       

     

       399
       +
       [Service]

     

       400
       +
       Environment=PORT=80

     

       401
       +
       Type=notify

     

       402
       +
       ExecStart=/opt/hello/bin/hello start

     

       403
       +
       WatchdogSec=1min

     

       404
       +
       ```

     

       405
       +
       

     

       406
       +
       This configuration says that if the VM will not send healthy message each 1

     

       407
       +
       minute interval, then the service will be marked as malfunctioning. From the

     

       408
       +
       application side we can manage state of the watchdog in several ways:

     

       409
       +
       

     

       410
       +
       - By setting `systemd.watchdog_check` configuration option we can configure the

     

       411
       +
         function that will be called on each check, if that function return `true`

     

       412
       +
         then it mean that application is healthy and the systemd should be notified

     

       413
       +
         with ping, if it returns `false` or fail, then the check will be omitted.

     

       414
       +
       - Manually sending trigger message in case of detected problems via

     

       415
       +
         `:systemd.watchdog(trigger)`, it will immediately mark service as

     

       416
       +
         malfunctioning and will trigger action defined in service unit file (by

     

       417
       +
         default it will restart application)

     

       418
       +
       - Disabling built in watchdog process via `:systemd.watchdog(:disable)` and then

     

       419
       +
         manually sending `:systemd.watchdog(:ping)` within expected intervals

     

       420
       +
         (discouraged)

     

       421
       +
       

     

       422
       +
       ## Security

     

       423
       +
       

     

       424
       +
       We should start with changing default user and group which is assigned to our

     

       425
       +
       process. We can do so in 2 different ways:

     

       426
       +
       

     

       427
       +
       1. Use some existing user and group by defining `User=` and `Group=` directives

     

       428
       +
          in our service definition; or

     

       429
       +
       2. Create ephemeral user on-demand before our service starts, by using directive

     

       430
       +
         `DynamicUser=true` in service definition.

     

       431
       +
       

     

       432
       +
       I prefer second option, as it additionally provides a lot of other security

     

       433
       +
       related options, like creating private `/tmp` directory, making system

     

       434
       +
       read-only, etc. This has also some disadvantages, like removing all of given

     

       435
       +
       data on service shutdown, however there are options to keep some data between

     

       436
       +
       launches.

     

       437
       +
       

     

       438
       +
       In addition to that we can add `PrivateDevices=true` that will hide all

     

       439
       +
       physical devices from `/dev` leaving only pseudo devices like `/dev/null` or

     

       440
       +
       `/dev/urandom` (so you will be able to use `:crypto` and `:ssl` modules without

     

       441
       +
       problems).

     

       442
       +
       

     

       443
       +
       Next thing is that we can do, is to [disable crash dumps generated by BEAM][crash].

     

       444
       +
       While not strictly needed in this case, it is worth remembering, that it isn't

     

       445
       +
       hard to achieve, just use `Environment=ERL_CRASH_DUMP_SECONDS=0`.

     

       446
       +
       

     

       447
       +
       Our new, more secure, `hello.service` will look like:

     

       448
       +
       

     

       449
       +
       ```ini

     

       450
       +
       [Unit]

     

       451
       +
       Description=Hello World service

     

       452
       +
       Requires=network.target

     

       453
       +
       

     

       454
       +
       [Service]

     

       455
       +
       Type=notify

     

       456
       +
       Environment=PORT=80

     

       457
       +
       ExecStart=/opt/hello/bin/hello start

     

       458
       +
       WatchdogSec=1min

     

       459
       +
       

     

       460
       +
       # We need to add capability to be able to bind on port 80

     

       461
       +
       CapabilityBoundingSet=CAP_NET_BIND_SERVICE

     

       462
       +
       

     

       463
       +
       # Hardening

     

       464
       +
       DynamicUser=true

     

       465
       +
       PrivateDevices=true

     

       466
       +
       Environment=ERL_CRASH_DUMP_SECONDS=0

     

       467
       +
       ```

     

       468
       +
       

     

       469
       +
       The problem with that configuration is that our service is now capable on

     

       470
       +
       binding **any** port under 1024, so for example, if there is some security

     

       471
       +
       issue, then the malicious party can open any of the restricted ports and then

     

       472
       +
       serve whatever data they want there. This can be quite problematic, and the

     

       473
       +
       solution for that problem will be covered in Part 2, where we will cover socket

     

       474
       +
       passing and socket activation for our service.

     

       475
       +
       

     

       476
       +
       With that we achieved quite basic level of isolation to what Docker (or other

     

       477
       +
       container runtime) is providing, but it do not require `overlayfs` or anything

     

       478
       +
       more, than what you already have on your machine. That means, updates done by

     

       479
       +
       your system package manager will be applied to all running services. With that

     

       480
       +
       you do not need to rebuild all your containers when there is security patch

     

       481
       +
       issued for any of your dependencies.

     

       482
       +
       

     

       483
       +
       Of course it only scratches the surface of what is possible with systemd wrt

     

       484
       +
       the hardening of the services. More information can be found in [RedHat

     

       485
       +
       article][rh-systemd-hardening] and in [`systemd-analyze security` command

     

       486
       +
       output][systemd-analyze-security]. Possible features are:

     

       487
       +
       

     

       488
       +
       - creation of the private networks for your services

     

       489
       +
       - disallowing creation of socket connections that are outside of the specified

     

       490
       +
         set of families

     

       491
       +
       - make only some paths readable

     

       492
       +
       - hide some paths from the process

     

       493
       +
       - etc.

     

       494
       +
       

     

       495
       +
       Coverage of just that topic is a little bit out of scope for this blog post, so

     

       496
       +
       I encourage you to read the documentation of [`systemd.exec`][systemd.exec] and

     

       497
       +
       articles mentioned above for more details.

     

       498
       +
       

     

       499
       +
       [crash]: https://erlef.github.io/security-wg/secure_coding_and_deployment_hardening/crash_dumps

     

       500
       +
       [rh-systemd-hardening]: https://www.redhat.com/sysadmin/mastering-systemd

     

       501
       +
       [systemd-analyze-security]: https://www.freedesktop.org/software/systemd/man/systemd-analyze.html#systemd-analyze%20security%20%5BUNIT...%5D

     

       502
       +
       [systemd.exec]: https://www.freedesktop.org/software/systemd/man/systemd.exec.html

     

       503
       +
       

     

       504
       +
       ## Summary

     

       505
       +
       

     

       506
       +
       This blog post is already quite lengthy, so I will split it into separate parts.

     

       507
       +
       There probably will be 3 of them:

     

       508
       +
       

     

       509
       +
       - [Part 1 - Basics, security, and FD passing (this one)](./#top)

     

       510
       +
       - [Part 2 - Socket activation](@/post/who-watches-watchmen-ii.md)

     

       511
       +
       - Part 3 - Logging

+412

content/post/who-watches-watchmen-ii.md

···

       1
       +
       +++

     

       2
       +
       title = "Who Watches Watchmen? - Part 2"

     

       3
       +
       date = 2023-11-14

     

       4
       +
       

     

       5
       +
       description = """

     

       6
       +
       Continuation of travel into making systemd to work for us, not against us. This

     

       7
       +
       time we will talk about socket activation and how to make our application run

     

       8
       +
       only when we need it to run.

     

       9
       +
       """

     

       10
       +
       

     

       11
       +
       [taxonomies]

     

       12
       +
       tags = [

     

       13
       +
         "beam",

     

       14
       +
         "systemd"

     

       15
       +
       ]

     

       16
       +
       

     

       17
       +
       [[extra.thanks]]

     

       18
       +
       name = "Nicodemus"

     

       19
       +
       why = "helping me with my poor English"

     

       20
       +
       +++

     

       21
       +
       

     

       22
       +
       This is continuation of [Part I][part-i] where I described the basics of the

     

       23
       +
       supervising BEAM applications with systemd and how to create basic, secure

     

       24
       +
       service for your Elixir application with it. In this article I will assume that

     

       25
       +
       you have read [the previous one][part-i].

     

       26
       +
       

     

       27
       +
       ______________________________________________________________________

     

       28
       +
       

     

       29
       +
       We already have our super simple service description. Just to refresh your

     

       30
       +
       memory, it is the `hello.service` file once again:

     

       31
       +
       

     

       32
       +
       ```ini

     

       33
       +
       [Unit]

     

       34
       +
       Description=Hello World service

     

       35
       +
       Requires=network.target

     

       36
       +
       

     

       37
       +
       [Service]

     

       38
       +
       Type=notify

     

       39
       +
       Environment=PORT=80

     

       40
       +
       ExecStart=/opt/hello/bin/hello start

     

       41
       +
       WatchdogSec=1min

     

       42
       +
       

     

       43
       +
       # We need to add capability to be able to bind on port 80

     

       44
       +
       CapabilityBoundingSet=CAP_NET_BIND_SERVICE

     

       45
       +
       

     

       46
       +
       # Hardening

     

       47
       +
       DynamicUser=true

     

       48
       +
       PrivateDevices=true

     

       49
       +
       Environment=ERL_CRASH_DUMP_SECONDS=0

     

       50
       +
       ```

     

       51
       +
       

     

       52
       +
       However there is one small problem. It allows our service to listen on **any**

     

       53
       +
       restricted port, not just `80` that we want to listen on. This can be

     

       54
       +
       troublesome as an attacker that gains RCE on our server can then capture any

     

       55
       +
       traffic on any port that we do not want to open (for example exposing port 22

     

       56
       +
       using the [`ssh`] module).

     

       57
       +
       

     

       58
       +
       It would be nice if we could somehow inject sockets for only the ports we want

     

       59
       +
       to listen to into our application.

     

       60
       +
       

     

       61
       +
       ## Socket passing

     

       62
       +
       

     

       63
       +
       Thanks to the [`systemd.socket`][systemd.socket] feature we can achieve that

     

       64
       +
       with a little work on our side.

     

       65
       +
       

     

       66
       +
       First we need to create new unit named `hello.socket` next to our

     

       67
       +
       `hello.service`:

     

       68
       +
       

     

       69
       +
       ```ini

     

       70
       +
       [Unit]

     

       71
       +
       Description=Listening socket

     

       72
       +
       Requires=sockets.target

     

       73
       +
       

     

       74
       +
       [Socket]

     

       75
       +
       ListenStream=80

     

       76
       +
       BindIPv6Only=both

     

       77
       +
       ReusePort=true

     

       78
       +
       NoDelay=true

     

       79
       +
       ```

     

       80
       +
       

     

       81
       +
       It will create a socket connected to TCP 80 (because we used `ListenStream=`,

     

       82
       +
       and TCP is the stream protocol). By default it will bind that socket to a

     

       83
       +
       service named the same as our socket, so now we need to edit our `hello.service`

     

       84
       +
       a little bit:

     

       85
       +
       

     

       86
       +
       ```ini

     

       87
       +
       [Unit]

     

       88
       +
       Description=Hello World service

     

       89
       +
       Requires=network.target

     

       90
       +
       

     

       91
       +
       [Service]

     

       92
       +
       Type=notify

     

       93
       +
       Environment=PORT=80

     

       94
       +
       ExecStart=/opt/hello/bin/hello start

     

       95
       +
       WatchdogSec=1min

     

       96
       +
       

     

       97
       +
       # See, we no longer need to insecurely allow binding to any port

     

       98
       +
       # CapabilityBoundingSet=CAP_NET_BIND_SERVICE

     

       99
       +
       

     

       100
       +
       # Hardening

     

       101
       +
       DynamicUser=true

     

       102
       +
       PrivateDevices=true

     

       103
       +
       Environment=ERL_CRASH_DUMP_SECONDS=0

     

       104
       +
       ```

     

       105
       +
       

     

       106
       +
       And we need to modify our `Hello.Application.cowboy_opts/0` to handle the socket

     

       107
       +
       which is passed to us a file descriptor:

     

       108
       +
       

     

       109
       +
       ```elixir

     

       110
       +
       # hello/application.ex

     

       111
       +
       defmodule Hello.Application do

     

       112
       +
         use Application

     

       113
       +
       

     

       114
       +
         def start(_type, _opts) do

     

       115
       +
           fds = :systemd.listen_fds()

     

       116
       +
       

     

       117
       +
           children = [

     

       118
       +
             {Plug.Cowboy, [scheme: :http, plug: Hello.Router] ++ cowboy_opts(fds)},

     

       119
       +
             {Plug.Cowboy.Drainer, refs: :all}

     

       120
       +
           ]

     

       121
       +
       

     

       122
       +
           Supervisor.start_link(children, strategy: :one_for_one)

     

       123
       +
         end

     

       124
       +
       

     

       125
       +
         # If there are no sockets passed to the application, then start listening on

     

       126
       +
         # the port specified by the `PORT` environment variable

     

       127
       +
         defp cowboy_opts([]) do

     

       128
       +
           [port: String.to_integer(System.get_env("PORT", "5000"))]

     

       129
       +
         end

     

       130
       +
       

     

       131
       +
         # If there are any socket passed, then use first one

     

       132
       +
         defp cowboy_opts([socket | _]) do

     

       133
       +
           fd =

     

       134
       +
             case socket do

     

       135
       +
               # Sockets can be named, which will be passed as the second element in

     

       136
       +
               # a tuple

     

       137
       +
               {fd, _name} -> fd

     

       138
       +
               # Or unnamed, and then it will be just the file descriptor

     

       139
       +
               fd -> fd

     

       140
       +
             end

     

       141
       +
       

     

       142
       +
           [

     

       143
       +
             net: :inet6, # (1)

     

       144
       +
             port: 0,     # (2)

     

       145
       +
             fd: fd       # (3)

     

       146
       +
           ]

     

       147
       +
         end

     

       148
       +
       end

     

       149
       +
       ```

     

       150
       +
       

     

       151
       +
       1. Systemd sockets are IPv6 enabled (we explicitly said that we want to listen

     

       152
       +
          on both). That means, that we need to mark our connection as an INET6

     

       153
       +
          connection. This will not affect IPv4 (INET) connections.

     

       154
       +
       1. We are required to pass `:port` key, but its value will be ignored, so we

     

       155
       +
          just pass `0`.

     

       156
       +
       1. We pass the file descriptor that will be then passed to the Cowboy listener.

     

       157
       +
       

     

       158
       +
       Now when we will start our service:

     

       159
       +
       

     

       160
       +
       ```txt

     

       161
       +
       # systemctl start hello.service

     

       162
       +
       ```

     

       163
       +
       

     

       164
       +
       It will be available at `https://localhost/` while still running as an

     

       165
       +
       unprivileged user.

     

       166
       +
       

     

       167
       +
       ### Multiple ports

     

       168
       +
       

     

       169
       +
       The question may arise - how to allow our service to listen on more than one

     

       170
       +
       port, for example you want to have your website available as HTTPS alongside

     

       171
       +
       "regular" HTTP. This means that our application needs to listen on two

     

       172
       +
       restricted ports:

     

       173
       +
       

     

       174
       +
       - 80 - for HTTP

     

       175
       +
       - 443 - for HTTPS

     

       176
       +
       

     

       177
       +
       Now we need to slightly modify a little our socket service and add another one.

     

       178
       +
       First rename our `hello.socket` to `hello-http.socket` and add a line

     

       179
       +
       `Service=hello.service` and `FileDescriptorName=http` to `[Socket]` section, so

     

       180
       +
       we end with:

     

       181
       +
       

     

       182
       +
       ```ini

     

       183
       +
       [Unit]

     

       184
       +
       Description=HTTP Socket

     

       185
       +
       Requires=sockets.target

     

       186
       +
       

     

       187
       +
       [Socket]

     

       188
       +
       # We declare the name of the file descriptor here to simplify extraction

     

       189
       +
       # in the application afterwards. By default it will be the socket name

     

       190
       +
       # (so `hello-http` in our case), but `http` is much cleaner.

     

       191
       +
       FileDescriptorName=http

     

       192
       +
       ListenStream=80

     

       193
       +
       Service=hello.service

     

       194
       +
       BindIPv6Only=both

     

       195
       +
       ReusePort=true

     

       196
       +
       NoDelay=true

     

       197
       +
       ```

     

       198
       +
       

     

       199
       +
       Next we create a similar file, but for HTTPS named `hello-https.socket`

     

       200
       +
       

     

       201
       +
       ```ini

     

       202
       +
       [Unit]

     

       203
       +
       Description=HTTPS Socket

     

       204
       +
       Requires=sockets.target

     

       205
       +
       

     

       206
       +
       [Socket]

     

       207
       +
       FileDescriptorName=https

     

       208
       +
       ListenStream=443

     

       209
       +
       Service=hello.service

     

       210
       +
       BindIPv6Only=both

     

       211
       +
       ReusePort=true

     

       212
       +
       NoDelay=true

     

       213
       +
       ```

     

       214
       +
       

     

       215
       +
       And we add the dependency on both of our sockets to the `hello.service`:

     

       216
       +
       

     

       217
       +
       ```ini

     

       218
       +
       [Unit]

     

       219
       +
       Description=Hello World service

     

       220
       +
       After=hello-http.socket hello-https.socket

     

       221
       +
       BindTo=hello-http.socket hello-https.socket

     

       222
       +
       

     

       223
       +
       [Service]

     

       224
       +
       ExecStart=/opt/hello/bin/hello start

     

       225
       +
       

     

       226
       +
       # Hardening

     

       227
       +
       DynamicUser=true

     

       228
       +
       PrivateDevices=true

     

       229
       +
       Environment=ERL_CRASH_DUMB_SECONDS=0

     

       230
       +
       ```

     

       231
       +
       

     

       232
       +
       Now we need to somehow differentiate between our sockets in the

     

       233
       +
       `Hello.Application`, so we will be able to pass the proper FD to each of the

     

       234
       +
       listeners. The `:systemd.listen_fds/0` will return a list of file descriptors,

     

       235
       +
       and if they are named, the format will be a 2-tuple where the first element is

     

       236
       +
       the file descriptor and the second is the name as a string:

     

       237
       +
       

     

       238
       +
       ```elixir

     

       239
       +
       # hello/application.ex

     

       240
       +
       defmodule Hello.Application do

     

       241
       +
         use Application

     

       242
       +
       

     

       243
       +
         def start(_type, _opts) do

     

       244
       +
           fds = :systemd.listen_fds()

     

       245
       +
       

     

       246
       +
           router = Hello.Router

     

       247
       +
       

     

       248
       +
           children = [

     

       249
       +
             {Plug.Cowboy, [

     

       250
       +
               scheme: :http,

     

       251
       +
               plug: router

     

       252
       +
             ] ++ cowboy_opts(fds, "http")},

     

       253
       +
             {Plug.Cowboy, [

     

       254
       +
               scheme: :https,

     

       255
       +
               plug: router,

     

       256
       +
               keyfile: "path/to/keyfile.pem",

     

       257
       +
               certfile: "path/to/certfile.pem",

     

       258
       +
               dhfile: "path/to/dhfile.pem"

     

       259
       +
             ] ++ cowboy_opts(fds, "https")},

     

       260
       +
             {Plug.Cowboy.Drainer, refs: :all}

     

       261
       +
           ]

     

       262
       +
       

     

       263
       +
           Supervisor.start_link(children, strategy: :one_for_one)

     

       264
       +
         end

     

       265
       +
       

     

       266
       +
         defp cowboy_opts(fds, protocol) do

     

       267
       +
           case List.keyfind(fds, protocol, 1) do

     

       268
       +
             # If there is socket passed for given protocol, then use that one

     

       269
       +
             {fd, ^protocol} ->

     

       270
       +
               [

     

       271
       +
                 net: :inet6,

     

       272
       +
                 port: 0,

     

       273
       +
                 fd: fd

     

       274
       +
               ]

     

       275
       +
       

     

       276
       +
             # If there are no sockets passed to the application that match

     

       277
       +
             # the protocol, then start listening on the port specified by

     

       278
       +
             # `PORT_{protocol}` environment variable

     

       279
       +
             _ ->

     

       280
       +
               [

     

       281
       +
                 port: String.to_integer(System.get_env("PORT_#{protocol}", "5000"))

     

       282
       +
               ]

     

       283
       +
         end

     

       284
       +
       end

     

       285
       +
       ```

     

       286
       +
       

     

       287
       +
       Now our application will listen on both - HTTP and HTTPS, despite running as

     

       288
       +
       unprivileged user.

     

       289
       +
       

     

       290
       +
       ## Socket activation

     

       291
       +
       

     

       292
       +
       Now, that we can inject sockets to our application with ease we can achieve even

     

       293
       +
       more fascinating feature - socket activation.

     

       294
       +
       

     

       295
       +
       Some of you may used `inetd` in the past, that allows you to dynamically start

     

       296
       +
       processes on network requests. It is quite an interesting tool that detects

     

       297
       +
       traffic on certain ports, then spawns a new process to handle it, passing data

     

       298
       +
       to and from that process via `STDIN` and `STDOUT`. There was a quirk though, it

     

       299
       +
       required the spawned process to shutdown after it handled the request and it was

     

       300
       +
       starting a new instance for each request. That works poorly with VMs like BEAM

     

       301
       +
       that have substantial startup time and are expected to be long-running systems.

     

       302
       +
       BEAM is capable of handling network requests on it's own.

     

       303
       +
       

     

       304
       +
       Fortunately for us, the way that we have implemented our systemd service is all

     

       305
       +
       that we need to have our application dynamically activated. To observe that we

     

       306
       +
       just need to shutdown everything:

     

       307
       +
       

     

       308
       +
       ```txt

     

       309
       +
       # systemctl stop hello-http.socket hello-https.socket hello.service

     

       310
       +
       ```

     

       311
       +
       

     

       312
       +
       And now relaunch **only the sockets**:

     

       313
       +
       

     

       314
       +
       ```txt

     

       315
       +
       # systemctl start hello-http.socket hello-https.socket

     

       316
       +
       ```

     

       317
       +
       

     

       318
       +
       We can check, that our service is not running:

     

       319
       +
       

     

       320
       +
       ```txt

     

       321
       +
       $ systemctl status hello.service

     

       322
       +
       ● hello.service - Hello World service

     

       323
       +
            Loaded: loaded (/usr/local/lib/systemd/system/hello.service; static; vendor preset: enabled)

     

       324
       +
            Active: inactive (dead)

     

       325
       +
       TriggeredBy: ● hello-http.socket ● hello-https.socket

     

       326
       +
       ```

     

       327
       +
       

     

       328
       +
       We can see the `TriggeredBy` section that tells us, that this service will be

     

       329
       +
       started by one of the sockets listed there. Let see what will happen when we

     

       330
       +
       will try to request anything from our application:

     

       331
       +
       

     

       332
       +
       ```txt

     

       333
       +
       $ curl http://localhost/

     

       334
       +
       Hello World!

     

       335
       +
       ```

     

       336
       +
       

     

       337
       +
       You can see that we got a response from our application. This mean that our

     

       338
       +
       application must have started, and indeed when we check:

     

       339
       +
       

     

       340
       +
       ```txt

     

       341
       +
       $ systemctl status hello.service

     

       342
       +
       ● hello.service - Hello

     

       343
       +
            Loaded: loaded (/usr/local/lib/systemd/system/hello.service; static; vendor preset: enabled)

     

       344
       +
            Active: active (running) since Thu 2022-02-03 13:20:27 CET; 4s ago

     

       345
       +
       TriggeredBy: ● hello-http.socket ● hello-https.socket

     

       346
       +
          Main PID: 1106 (beam.smp)

     

       347
       +
             Tasks: 19 (limit: 1136)

     

       348
       +
            Memory: 116.7M

     

       349
       +
            CGroup: /system.slice/hello.service

     

       350
       +
                    ├─1106 /opt/hello/erts-12.2/bin/beam.smp -- -root /opt/hello -progname erl -- -home /run/hello -- -noshell -s elixir start_cli -mode embedded -setcookie CR63SVI6L5JAMJSDL3H4XPNMOPHEWSV2FPHCHCAN65CY6ASHMXBA==== -sname hello -c>

     

       351
       +
                    └─1138 erl_child_setup 1024

     

       352
       +
       ```

     

       353
       +
       

     

       354
       +
       It seems to be running, and if we stop it, then we will get information that it

     

       355
       +
       still can be activated by our sockets:

     

       356
       +
       

     

       357
       +
       ```txt

     

       358
       +
       # systemctl stop hello.service

     

       359
       +
       Warning: Stopping hello.service, but it can still be activated by:

     

       360
       +
         hello-http.socket hello-https.socket

     

       361
       +
       ```

     

       362
       +
       

     

       363
       +
       That means, that systemd is still listening on the sockets that we defined, even

     

       364
       +
       when our application is down, and will start our application again as soon as

     

       365
       +
       there are any incoming requests.

     

       366
       +
       

     

       367
       +
       Let test that out again:

     

       368
       +
       

     

       369
       +
       ```txt

     

       370
       +
       $ curl http://localhost/

     

       371
       +
       Hello World!

     

       372
       +
       $ systemctl status hello.service

     

       373
       +
       ● hello.service - Hello

     

       374
       +
            Loaded: loaded (/usr/local/lib/systemd/system/hello.service; static; vendor preset: enabled)

     

       375
       +
            Active: active (running) since Thu 2022-02-03 13:22:27 CET; 4s ago

     

       376
       +
       TriggeredBy: ● hello-http.socket ● hello-https.socket

     

       377
       +
          Main PID: 3452 (beam.smp)

     

       378
       +
             Tasks: 19 (limit: 1136)

     

       379
       +
            Memory: 116.7M

     

       380
       +
            CGroup: /system.slice/hello.service

     

       381
       +
                    ├─3452 /opt/hello/erts-12.2/bin/beam.smp -- -root /opt/hello -progname erl -- -home /run/hello -- -noshell -s elixir start_cli -mode embedded -setcookie CR63SVI6L5JAMJSDL3H4XPNMOPHEWSV2FPHCHCAN65CY6ASHMXBA==== -sname hello -c>

     

       382
       +
                    └─3453 erl_child_setup 1024

     

       383
       +
       ```

     

       384
       +
       

     

       385
       +
       Our application got launched again, automatically, just by the fact that

     

       386
       +
       there was incoming TCP connection.

     

       387
       +
       

     

       388
       +
       Does it work for HTTPS connection as well?

     

       389
       +
       

     

       390
       +
       ```txt

     

       391
       +
       # systemctl stop hello.service

     

       392
       +
       $ curl -k https://localhost/

     

       393
       +
       Hello World!

     

       394
       +
       ```

     

       395
       +
       

     

       396
       +
       It seems so. Independently of which port we try to reach our application on, it

     

       397
       +
       will be automatically launched for us and the connection will be properly

     

       398
       +
       handled. Do note that systemd will not shut down our process after serving the

     

       399
       +
       request. It will continue to run from that point forward.

     

       400
       +
       

     

       401
       +
       ## Summary

     

       402
       +
       

     

       403
       +
       I know that it took quite while since the last post (ca. 1.5 years), but I hope

     

       404
       +
       that I will be able to write the final part much sooner than this.

     

       405
       +
       

     

       406
       +
       - [Part 1 - Basics, security, and FD passing][part-i]

     

       407
       +
       - [Part 2 - Socket activation (this one)](./#top)

     

       408
       +
       - Part 3 - Logging

     

       409
       +
       

     

       410
       +
       [part-i]: @/post/who-watches-watchmen-i.md

     

       411
       +
       [systemd.socket]: https://www.freedesktop.org/software/systemd/man/systemd.socket.html

     

       412
       +
       [`ssh`]: https://erlang.org/doc/man/ssh.html

-27

content/post/who-watches-watchmen.md

···

       1
       -
       +++

     

       2
       -
       title = "Who Watches Watchmen"

     

       3
       -
       date = 2020-02-01T23:13:44+01:00

     

       4
       -
       draft = true

     

       5
       -
       +++

     

       6
       -
       

     

       7
       -
       ## OTP supervisors

     

       8
       -
       

     

       9
       -
       If you are reading this post then you probably found it via Erlang/Elixir

     

       10
       -
       community so you should be at least a little bit familiar with the OTP

     

       11
       -
       supervisors concept. If you aren't yet because you have found it by other matter

     

       12
       -
       then I highly encourage you to learn a little about it, however I will try to

     

       13
       -
       introduce that concept a little bit there as well.

     

       14
       -
       

     

       15
       -
       ### Erlang process tree

     

       16
       -
       

     

       17
       -
       In Erlang the basic "building block" of the whole application is something

     

       18
       -
       called process. It is very much like system process (we will expand that

     

       19
       -
       later), but much less costly to spawn. The 

     

       20
       -
       

     

       21
       -
       ## Why we need system supervisor

     

       22
       -
       

     

       23
       -
       ## How system supervisor works

     

       24
       -
       

     

       25
       -
       ## How to use OTP with systemd

     

       26
       -
       

     

       27
       -
       ## What will be possible in future

+291

content/post/writing-tests.md

···

       1
       +
       +++

     

       2
       +
       date = 2023-11-20

     

       3
       +
       title = "How do I write Elixir tests?"

     

       4
       +
       

     

       5
       +
       draft = true

     

       6
       +
       

     

       7
       +
       [taxonomies]

     

       8
       +
       tags = [

     

       9
       +
           "beam",

     

       10
       +
           "testing"

     

       11
       +
       ]

     

       12
       +
       +++

     

       13
       +
       

     

       14
       +
       This post was created for myself to codify some basic guides that I use while

     

       15
       +
       writing tests. If you, my dear reader, read this then there is one important

     

       16
       +
       thing for you to remember:

     

       17
       +
       

     

       18
       +
       These are **guides** not *rules*. Each code base is different deviations and are

     

       19
       +
       expected and *will* happen. Just use the thing between your ears.

     

       20
       +
       

     

       21
       +
       ## `@subject` module attribute for module under test

     

       22
       +
       

     

       23
       +
       While writing test in Elixir it is not always obvious what we are testing. Just

     

       24
       +
       imagine test like:

     

       25
       +
       

     

       26
       +
       ```elixir

     

       27
       +
       test "foo should frobnicate when bar" do

     

       28
       +
         bar = pick_bar()

     

       29
       +
       

     

       30
       +
         assert :ok == MyBehaviour.foo(MyImplementation, bar)

     

       31
       +
       end

     

       32
       +
       ```

     

       33
       +
       

     

       34
       +
       It is not obvious at the first sight what we are testing. And it is pretty

     

       35
       +
       simplified example, in real world it can became even harder to notice what is

     

       36
       +
       module under test (MUT).

     

       37
       +
       

     

       38
       +
       To resolve that I came up with a simple solution. I create module attribute

     

       39
       +
       named `@subject` that points to the MUT:

     

       40
       +
       

     

       41
       +
       ```elixir

     

       42
       +
       @subject MyImplementation

     

       43
       +
       

     

       44
       +
       test "foo should frobnicate when bar" do

     

       45
       +
         bar = pick_bar()

     

       46
       +
       

     

       47
       +
         assert :ok == MyBehaviour.foo(@subject, bar)

     

       48
       +
       end

     

       49
       +
       ```

     

       50
       +
       

     

       51
       +
       Now it is more obvious what is MUT and what is just wrapper code around it.

     

       52
       +
       

     

       53
       +
       In the past I have been using `alias` with `:as` option, like:

     

       54
       +
       

     

       55
       +
       ```elixir

     

       56
       +
       alias MyImplementation, as: Subject

     

       57
       +
       ```

     

       58
       +
       

     

       59
       +
       However I find module attribute to be more visually outstanding and make it

     

       60
       +
       easier for me to notice `@subject` than `Subject`. But your mileage may vary.

     

       61
       +
       

     

       62
       +
       ## `describe` with function name

     

       63
       +
       

     

       64
       +
       That one is pretty basic, and I have seen that it is pretty standard for people:

     

       65
       +
       when you are writing tests for module functions, then group them in `describe`

     

       66
       +
       blocks that will contain name (and arity) of the function in the name. Example:

     

       67
       +
       

     

       68
       +
       ```elixir

     

       69
       +
       # Module under test

     

       70
       +
       defmodule Foo do

     

       71
       +
         def a(x, y, z) do

     

       72
       +
           # some code

     

       73
       +
         end

     

       74
       +
       end

     

       75
       +
       

     

       76
       +
       # Tests

     

       77
       +
       defmodule FooTest do

     

       78
       +
         use ExUnit.Case, async: true

     

       79
       +
       

     

       80
       +
         @subject Foo

     

       81
       +
       

     

       82
       +
         describe "a/3" do

     

       83
       +
           # Some tests here

     

       84
       +
         end

     

       85
       +
       end

     

       86
       +
       ```

     

       87
       +
       

     

       88
       +
       This allows me to see what functionality I am testing.

     

       89
       +
       

     

       90
       +
       Of course that doesn't apply to the Phoenix controllers, as there we do not test

     

       91
       +
       functions, but tuples in form `{method, path}` which I then write as `METHOD

     

       92
       +
       path`, for example `POST /users`.

     

       93
       +
       

     

       94
       +
       ## Avoid module mocking

     

       95
       +
       

     

       96
       +
       In Elixir we have bunch of the mocking libraries out there, but most of them

     

       97
       +
       have quite substantial issue for me - these prevent me from using `async: true`

     

       98
       +
       for my tests. This often causes substantial performance hit, as it prevents

     

       99
       +
       different modules to run in parallel (not single tests, *modules*, but that is

     

       100
       +
       probably material for another post).

     

       101
       +
       

     

       102
       +
       Instead of mocks I prefer to utilise dependency injection. Some people may argue

     

       103
       +
       that "Elixir is FP, not OOP, there is no need for DI" and they cannot be further

     

       104
       +
       from truth. DI isn't related to OOP, it just have different form, called

     

       105
       +
       function arguments. For example, if we want to have function that do something

     

       106
       +
       with time, in particular - current time. Then instead of writing:

     

       107
       +
       

     

       108
       +
       ```elixir

     

       109
       +
       def my_function(a, b) do

     

       110
       +
         do_foo(a, b, DateTime.utc_now())

     

       111
       +
       end

     

       112
       +
       ```

     

       113
       +
       

     

       114
       +
       Which would require me to use mocks for `DateTime` or other workarounds to make

     

       115
       +
       tests time-independent. I would do:

     

       116
       +
       

     

       117
       +
       ```elixir

     

       118
       +
       def my_function(a, b, now \\ DateTime.utc_now()) do

     

       119
       +
         do_foo(a, b, now)

     

       120
       +
       end

     

       121
       +
       ```

     

       122
       +
       

     

       123
       +
       Which still provide me the ergonomics of `my_function/2` as above, but is way

     

       124
       +
       easier to test, as I can pass the date to the function itself. This allows me to

     

       125
       +
       run this test in parallel as it will not cause other tests to do weird stuff

     

       126
       +
       because of altered `DateTime` behaviour.

     

       127
       +
       

     

       128
       +
       ## Avoid `ex_machina` factories

     

       129
       +
       

     

       130
       +
       I have poor experience with tools like `ex_machina` or similar. These often

     

       131
       +
       bring whole [Banana Gorilla Jungle problem][bgj] back, just changed a little, as

     

       132
       +
       now instead of just passing data around, we create all needless structures for

     

       133
       +
       sole purpose of test, even when they aren't needed for anything.

     

       134
       +
       

     

       135
       +
       [bgj]: https://softwareengineering.stackexchange.com/q/368797

     

       136
       +
       

     

       137
       +
       Start with example from [ExMachina README](https://github.com/beam-community/ex_machina#overview):

     

       138
       +
       

     

       139
       +
       ```elixir

     

       140
       +
       defmodule MyApp.Factory do

     

       141
       +
         # with Ecto

     

       142
       +
         use ExMachina.Ecto, repo: MyApp.Repo

     

       143
       +
       

     

       144
       +
         # without Ecto

     

       145
       +
         use ExMachina

     

       146
       +
       

     

       147
       +
         def user_factory do

     

       148
       +
           %MyApp.User{

     

       149
       +
             name: "Jane Smith",

     

       150
       +
             email: sequence(:email, &"email-#{&1}@example.com"),

     

       151
       +
             role: sequence(:role, ["admin", "user", "other"]),

     

       152
       +
           }

     

       153
       +
         end

     

       154
       +
       

     

       155
       +
         def article_factory do

     

       156
       +
           title = sequence(:title, &"Use ExMachina! (Part #{&1})")

     

       157
       +
           # derived attribute

     

       158
       +
           slug = MyApp.Article.title_to_slug(title)

     

       159
       +
           %MyApp.Article{

     

       160
       +
             title: title,

     

       161
       +
             slug: slug,

     

       162
       +
             # associations are inserted when you call `insert`

     

       163
       +
             author: build(:user),

     

       164
       +
           }

     

       165
       +
         end

     

       166
       +
       

     

       167
       +
         # derived factory

     

       168
       +
         def featured_article_factory do

     

       169
       +
           struct!(

     

       170
       +
             article_factory(),

     

       171
       +
             %{

     

       172
       +
               featured: true,

     

       173
       +
             }

     

       174
       +
           )

     

       175
       +
         end

     

       176
       +
       

     

       177
       +
         def comment_factory do

     

       178
       +
           %MyApp.Comment{

     

       179
       +
             text: "It's great!",

     

       180
       +
             article: build(:article),

     

       181
       +
             author: build(:user) # That line is added by me

     

       182
       +
           }

     

       183
       +
         end

     

       184
       +
       end

     

       185
       +
       ```

     

       186
       +
       

     

       187
       +
       For start we can see a single problem there - we do not validate our factories

     

       188
       +
       against our schema changesets. Without additional tests like:

     

       189
       +
       

     

       190
       +
       ```elixir

     

       191
       +
       @subject MyApp.Article

     

       192
       +
       

     

       193
       +
       test "factory conforms to changeset" do

     

       194
       +
         changeset = @subject.changeset(%@subject{}, params_for(:article))

     

       195
       +
       

     

       196
       +
         assert changeset.valid?

     

       197
       +
       end

     

       198
       +
       ```

     

       199
       +
       

     

       200
       +
       We cannot be sure that our tests test what we want them to test. And if we pass

     

       201
       +
       custom attribute values in some tests it gets even worse, because we cannot be

     

       202
       +
       sure if these are conforming either.

     

       203
       +
       

     

       204
       +
       That mean that our tests may be moot, because we aren't testing against real

     

       205
       +
       situations, but against some predefined state.

     

       206
       +
       

     

       207
       +
       Another problem is that if we need to alter the behaviour of the factory it can

     

       208
       +
       became quite convoluted. Imagine situation when we want to test if comments by

     

       209
       +
       author of the post have some special behaviour (for example it has some

     

       210
       +
       additional CSS class to be able to mark them in CSS). That require from us to do

     

       211
       +
       some dancing around passing custom attributes:

     

       212
       +
       

     

       213
       +
       ```elixir

     

       214
       +
       test "comments by author are special" do

     

       215
       +
         post = insert(:post)

     

       216
       +
         comment = insert(:comment, post: post, author: post.author)

     

       217
       +
       

     

       218
       +
         # rest of the test

     

       219
       +
       end

     

       220
       +
       ```

     

       221
       +
       

     

       222
       +
       And this is simplified example. In the past I needed to deal with situations

     

       223
       +
       where I was creating a lot of data to pass through custom attributes to make

     

       224
       +
       test sensible.

     

       225
       +
       

     

       226
       +
       Instead I prefer to do stuff directly in code. Instead of relying on some

     

       227
       +
       "magical" functions provided by some "magical" macros from external library I

     

       228
       +
       can use what I already have - functions in my application.

     

       229
       +
       

     

       230
       +
       Instead of:

     

       231
       +
       

     

       232
       +
       ```elixir

     

       233
       +
       test "comments by author are special" do

     

       234
       +
         post = insert(:post)

     

       235
       +
         comment = insert(:comment, post: post, author: post.author)

     

       236
       +
       

     

       237
       +
         # rest of the test

     

       238
       +
       end

     

       239
       +
       ```

     

       240
       +
       

     

       241
       +
       Write:

     

       242
       +
       

     

       243
       +
       ```elixir

     

       244
       +
       test "comments by author are special" do

     

       245
       +
         author = MyApp.Users.create(%{

     

       246
       +
             name: "John Doe",

     

       247
       +
             email: "john@example.com"

     

       248
       +
           })

     

       249
       +
         post = MyApp.Blog.create_article(%{

     

       250
       +
             author: author,

     

       251
       +
             content: "Foo bar",

     

       252
       +
             title: "Foo bar"

     

       253
       +
           })

     

       254
       +
         comment = MyApp.Blog.create_comment_for(article, %{

     

       255
       +
             author: author,

     

       256
       +
             content: "Foo bar"

     

       257
       +
           })

     

       258
       +
       

     

       259
       +
         # rest of the test

     

       260
       +
       end

     

       261
       +
       ```

     

       262
       +
       

     

       263
       +
       It may be a little bit more verbose, but it makes tests way more readable in my

     

       264
       +
       opinion. You have all details just in place and you know what to expect. And if

     

       265
       +
       you need some piece of data in all (or almost all) tests within

     

       266
       +
       module/`describe` block, then you can always can use `setup/1` blocks. Or you

     

       267
       +
       can create function per module that will generate data for you. As long as your

     

       268
       +
       test module is self-contained and do not receive "magical" data out of thin air,

     

       269
       +
       it is ok for me. But `ex_machina` is, in my opinion, terrible idea brought from

     

       270
       +
       Rails world, that make little to no sense in Elixir.

     

       271
       +
       

     

       272
       +
       If you really need such factories, then just write your own functions that will

     

       273
       +
       use your contexts instead of relying on another library. For example:

     

       274
       +
       

     

       275
       +
       ```elixir

     

       276
       +
       import ExUnit.Assertions

     

       277
       +
       

     

       278
       +
       def create_user(name, email \\ nil, attrs \\ %{}) do

     

       279
       +
         email = email || "#{String.replace(name, " ", ".")}@example.com"

     

       280
       +
         attrs = Map.merge(attrs, %{name: name, email: email})

     

       281
       +
       

     

       282
       +
         assert {:ok, user} = MyApp.Users.create(attrs)

     

       283
       +
       

     

       284
       +
         user

     

       285
       +
       end

     

       286
       +
       

     

       287
       +
       # And so on…

     

       288
       +
       ```

     

       289
       +
       

     

       290
       +
       This way you do not need to check if all tests use correct validations any

     

       291
       +
       longer, as your system will do that for you.

+2 -3

content/post/writing-vim-plugin.md

···

       3
        
       date = 2019-11-04T18:21:18+01:00

     

       4
        
       description = """

     

       5
        
       Article about writing Vim plugins, but not about writing Vim plugins. It is

     

       6
       -
       how to concieve plugin, how to go from an idea to the full fledged plugin."""

     

       7
        
       

     

       8
        
       [taxonomies]

     

       9
        
       tags = [

     

       10
       -
         "vim",

     

       11
       -
         "viml"

     

       12
        
       ]

     

       13
        
       +++

     

       14

···

       3
        
       date = 2019-11-04T18:21:18+01:00

     

       4
        
       description = """

     

       5
        
       Article about writing Vim plugins, but not about writing Vim plugins. It is

     

       6
       +
       how to conceive plugin, how to go from an idea to the full fledged plugin."""

     

       7
        
       

     

       8
        
       [taxonomies]

     

       9
        
       tags = [

     

       10
       +
         "vim"

     

       0
        
       
     

       11
        
       ]

     

       12
        
       +++

     

       13

-22

default.nix

···

       1
       -
       { pkgs ? import <nixpkgs> {}, ... }:

     

       2
       -
       

     

       3
       -
       with pkgs;

     

       4
       -
       

     

       5
       -
       stdenv.mkDerivation {

     

       6
       -
         name = "hauleth-blog";

     

       7
       -
         src = ./.;

     

       8
       -
       

     

       9
       -
         nativeBuildInputs = [ git ];

     

       10
       -
         buildInputs = [ zola ];

     

       11
       -
       

     

       12
       -
         buildPhase = ''

     

       13
       -
           git submodule update --init --recursive --depth=1

     

       14
       -
           zola build -o $out

     

       15
       -
           '';

     

       16
       -
       

     

       17
       -
         dontInstall = true;

     

       18
       -
       

     

       19
       -
         passthru = {

     

       20
       -
           inherit zola;

     

       21
       -
         };

     

       22
       -
       }

+57

flake.lock

···

       1
       +
       {

     

       2
       +
         "nodes": {

     

       3
       +
           "flake-utils": {

     

       4
       +
             "inputs": {

     

       5
       +
               "systems": "systems"

     

       6
       +
             },

     

       7
       +
             "locked": {

     

       8
       +
               "lastModified": 1731533236,

     

       9
       +
               "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",

     

       10
       +
               "owner": "numtide",

     

       11
       +
               "repo": "flake-utils",

     

       12
       +
               "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",

     

       13
       +
               "type": "github"

     

       14
       +
             },

     

       15
       +
             "original": {

     

       16
       +
               "owner": "numtide",

     

       17
       +
               "repo": "flake-utils",

     

       18
       +
               "type": "github"

     

       19
       +
             }

     

       20
       +
           },

     

       21
       +
           "nixpkgs": {

     

       22
       +
             "locked": {

     

       23
       +
               "lastModified": 0,

     

       24
       +
               "narHash": "sha256-cnL5WWn/xkZoyH/03NNUS7QgW5vI7D1i74g48qplCvg=",

     

       25
       +
               "path": "/nix/store/h15y13p2w17dhpiyh8pk42v1k4c38a0h-source",

     

       26
       +
               "type": "path"

     

       27
       +
             },

     

       28
       +
             "original": {

     

       29
       +
               "id": "nixpkgs",

     

       30
       +
               "type": "indirect"

     

       31
       +
             }

     

       32
       +
           },

     

       33
       +
           "root": {

     

       34
       +
             "inputs": {

     

       35
       +
               "flake-utils": "flake-utils",

     

       36
       +
               "nixpkgs": "nixpkgs"

     

       37
       +
             }

     

       38
       +
           },

     

       39
       +
           "systems": {

     

       40
       +
             "locked": {

     

       41
       +
               "lastModified": 1681028828,

     

       42
       +
               "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",

     

       43
       +
               "owner": "nix-systems",

     

       44
       +
               "repo": "default",

     

       45
       +
               "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",

     

       46
       +
               "type": "github"

     

       47
       +
             },

     

       48
       +
             "original": {

     

       49
       +
               "owner": "nix-systems",

     

       50
       +
               "repo": "default",

     

       51
       +
               "type": "github"

     

       52
       +
             }

     

       53
       +
           }

     

       54
       +
         },

     

       55
       +
         "root": "root",

     

       56
       +
         "version": 7

     

       57
       +
       }

+51

flake.nix

···

       1
       +
       {

     

       2
       +
         description = "Flake utils demo";

     

       3
       +
       

     

       4
       +
         inputs.flake-utils.url = "github:numtide/flake-utils";

     

       5
       +
       

     

       6
       +
         outputs = { self, nixpkgs, flake-utils }:

     

       7
       +
           flake-utils.lib.eachDefaultSystem (system:

     

       8
       +
             let

     

       9
       +
               pkgs = import nixpkgs { inherit system; };

     

       10
       +
               blog = pkgs.stdenvNoCC.mkDerivation {

     

       11
       +
                 name = "hauleth-blog";

     

       12
       +
                 src = ./.;

     

       13
       +
       

     

       14
       +
                 nativeBuildInputs = [

     

       15
       +
                   pkgs.zola

     

       16
       +
                 ];

     

       17
       +
       

     

       18
       +
                 buildPhase = ''

     

       19
       +
                   zola --version

     

       20
       +
                   zola build --output-dir $out

     

       21
       +
                 '';

     

       22
       +
       

     

       23
       +
                 dontInstall = true;

     

       24
       +
               };

     

       25
       +
             in

     

       26
       +
             {

     

       27
       +
               apps.publish = let

     

       28
       +
                 program = pkgs.writeShellScript "publish" ''

     

       29
       +
                   cp -r ${self.packages.${system}.blog} public

     

       30
       +
                   '';

     

       31
       +
               in {

     

       32
       +
                 type = "app";

     

       33
       +
                 program = "${program}";

     

       34
       +
               };

     

       35
       +
               packages = {

     

       36
       +
                 inherit blog;

     

       37
       +
               };

     

       38
       +
               defaultPackage = blog;

     

       39
       +
       

     

       40
       +
               devShells.default = pkgs.mkShell {

     

       41
       +
                 inputsFrom = [ blog ];

     

       42
       +
       

     

       43
       +
                 packages = [

     

       44
       +
                   # pkgs.netlify-cli

     

       45
       +
                   pkgs.vale

     

       46
       +
                   pkgs.mdl

     

       47
       +
                 ];

     

       48
       +
               };

     

       49
       +
             }

     

       50
       +
           );

     

       51
       +
       }

-2

layouts/partials/extended_head.html

···

       1
       -
       <script async defer data-domain="hauleth.dev" src="https://plausible.io/js/plausible.js"></script>

     

       2
       -

+54

netlify.toml

···

       1
       +
       [build]

     

       2
       +
         command = "zola build"

     

       3
       +
         publish = "public/"

     

       4
       +
       

     

       5
       +
         [build.environment]

     

       6
       +
           ZOLA_VERSION = "0.20.0"

     

       7
       +
       

     

       8
       +
       [context.deploy-preview]

     

       9
       +
         command = "zola build --drafts --base-url $DEPLOY_PRIME_URL"

     

       10
       +
       

     

       11
       +
       [[headers]]

     

       12
       +
         for = "/*"

     

       13
       +
         [headers.values]

     

       14
       +
           # Disable Google cohort tracking

     

       15
       +
           Permission-Policy = "interest-cohort=()"

     

       16
       +
           # Disallow showing the website in frames

     

       17
       +
           X-Frame-Options = "DENY"

     

       18
       +
           X-XSS-Protection = "1; mode=block"

     

       19
       +
           X-Content-Type-Options = "nosniff"

     

       20
       +
           X-Clacks-Overhead = "GNU Terry Pratchett"

     

       21
       +
           Content-Security-Policy = "default-src 'self'; script-src 'self'; connect-src 'self'; img-src https:"

     

       22
       +
           Permissions-Policy = "accelerometer=(), ambient-light-sensor=(), autoplay=(), battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), microphone=(), midi=(), navigation-override=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(), usb=(), web-share=(), xr-spatial-tracking=(), clipboard-read=(), clipboard-write=(), gamepad=(), speaker-selection=()"

     

       23
       +
           Referrer-Policy = "no-referrer-when-downgrade"

     

       24
       +
       

     

       25
       +
       [[headers]]

     

       26
       +
         for = "/.well-known/webfinger"

     

       27
       +
         [headers.values]

     

       28
       +
           Content-Type = "application/jrd+json; charset=utf-8"

     

       29
       +
       

     

       30
       +
       [[redirects]]

     

       31
       +
         from = "/post"

     

       32
       +
         to = "/"

     

       33
       +
         force = true

     

       34
       +
       

     

       35
       +
       [[redirects]]

     

       36
       +
         from = "/.well-known/webfinger"

     

       37
       +
         to = "https://fosstodon.org/.well-known/webfinger?resource=acct:hauleth@fosstodon.org"

     

       38
       +
         status = 200

     

       39
       +
       

     

       40
       +
       [[redirects]]

     

       41
       +
         from = "/js/script.js"

     

       42
       +
         to = "https://plausible.io/js/script.js"

     

       43
       +
         status = 200

     

       44
       +
       

     

       45
       +
       [[redirects]]

     

       46
       +
         from = "/api/event"

     

       47
       +
         to = "https://plausible.io/api/event"

     

       48
       +
         status = 200

     

       49
       +
       

     

       50
       +
       [[plugins]]

     

       51
       +
         package = "netlify-plugin-webmentions"

     

       52
       +
       

     

       53
       +
         [plugins.inputs]

     

       54
       +
         feedPath = "atom.xml"

+65

sass/_buttons.scss

···

       1
       +
       button,

     

       2
       +
       .button,

     

       3
       +
       a.button {

     

       4
       +
         position: relative;

     

       5
       +
         display: flex;

     

       6
       +
         align-items: center;

     

       7
       +
         justify-content: center;

     

       8
       +
         padding: 8px 18px;

     

       9
       +
         margin-bottom: 5px;

     

       10
       +
         text-decoration: none;

     

       11
       +
         text-align: center;

     

       12
       +
         border-radius: 8px;

     

       13
       +
         border: 1px solid transparent;

     

       14
       +
         appearance: none;

     

       15
       +
         cursor: pointer;

     

       16
       +
         outline: none;

     

       17
       +
       

     

       18
       +
         /* variants */

     

       19
       +
       

     

       20
       +
         &.outline {

     

       21
       +
           background: transparent;

     

       22
       +
           box-shadow: none;

     

       23
       +
           padding: 8px 18px;

     

       24
       +
       

     

       25
       +
           :hover {

     

       26
       +
             transform: none;

     

       27
       +
             box-shadow: none;

     

       28
       +
           }

     

       29
       +
         }

     

       30
       +
       

     

       31
       +
         &.primary {

     

       32
       +
           box-shadow: 0 4px 6px rgba(50, 50, 93, .11), 0 1px 3px rgba(0, 0, 0, .08);

     

       33
       +
       

     

       34
       +
           &:hover {

     

       35
       +
             box-shadow: 0 2px 6px rgba(50, 50, 93, .21), 0 1px 3px rgba(0, 0, 0, .08);

     

       36
       +
           }

     

       37
       +
         }

     

       38
       +
       

     

       39
       +
         &.link {

     

       40
       +
           background: none;

     

       41
       +
           font-size: 1rem;

     

       42
       +
         }

     

       43
       +
       

     

       44
       +
         /* sizes */

     

       45
       +
       

     

       46
       +
         &.small {

     

       47
       +
           font-size: .8rem;

     

       48
       +
         }

     

       49
       +
       

     

       50
       +
         &.wide {

     

       51
       +
           min-width: 200px;

     

       52
       +
           padding: 14px 24px;

     

       53
       +
         }

     

       54
       +
       }

     

       55
       +
       

     

       56
       +
       a.read-more,

     

       57
       +
       a.read-more:hover,

     

       58
       +
       a.read-more:active {

     

       59
       +
         display: inline-flex;

     

       60
       +
         background: none;

     

       61
       +
         box-shadow: none;

     

       62
       +
         padding: 0;

     

       63
       +
         margin: 20px 0;

     

       64
       +
         max-width: 100%;

     

       65
       +
       }

+53

sass/_footer.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       .footer {

     

       4
       +
         @media print {

     

       5
       +
           display: none;

     

       6
       +
         }

     

       7
       +
       

     

       8
       +
         padding: 40px 0;

     

       9
       +
         flex-grow: 0;

     

       10
       +
         opacity: .5;

     

       11
       +
       

     

       12
       +
         &__inner {

     

       13
       +
           display: flex;

     

       14
       +
           align-items: center;

     

       15
       +
           justify-content: space-between;

     

       16
       +
           margin: 0;

     

       17
       +
           width: 760px;

     

       18
       +
           max-width: 100%;

     

       19
       +
       

     

       20
       +
           @media (max-width: $tablet-max-width) {

     

       21
       +
             flex-direction: column;

     

       22
       +
           }

     

       23
       +
         }

     

       24
       +
       

     

       25
       +
         a {

     

       26
       +
           color: inherit;

     

       27
       +
         }

     

       28
       +
       

     

       29
       +
         .copyright {

     

       30
       +
           width: 100%;

     

       31
       +
           display: flex;

     

       32
       +
           flex-direction: column;

     

       33
       +
           align-items: center;

     

       34
       +
           justify-content: center;

     

       35
       +
           // so `--light-color-secondary` color exists no where else in the stylings

     

       36
       +
           // color: var(--light-color-secondary);

     

       37
       +
           // As a substitute, I'm going to use the alpha-70 version of accent.

     

       38
       +
           color: var(--accent-alpha-70);

     

       39
       +
       

     

       40
       +
           & > *:first-child:not(:only-child) {

     

       41
       +
             margin-right: 10px;

     

       42
       +
       

     

       43
       +
             @media (max-width: $tablet-max-width) {

     

       44
       +
               margin: 0;

     

       45
       +
             }

     

       46
       +
           }

     

       47
       +
       

     

       48
       +
           @media (max-width: $tablet-max-width) {

     

       49
       +
             // flex-direction: column;

     

       50
       +
             margin-top: 10px;

     

       51
       +
           }

     

       52
       +
         }

     

       53
       +
       }

+70

sass/_header.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       .header {

     

       4
       +
         @media print {

     

       5
       +
           display: none;

     

       6
       +
         }

     

       7
       +
       

     

       8
       +
         display: flex;

     

       9
       +
         flex-direction: column;

     

       10
       +
         position: relative;

     

       11
       +
       

     

       12
       +
         &__inner {

     

       13
       +
           display: flex;

     

       14
       +
           align-items: center;

     

       15
       +
           justify-content: space-between;

     

       16
       +
         }

     

       17
       +
       

     

       18
       +
         &__logo {

     

       19
       +
           display: flex;

     

       20
       +
           flex: 1;

     

       21
       +
       

     

       22
       +
           &:after {

     

       23
       +
             content: '';

     

       24
       +
             background: repeating-linear-gradient(90deg, var(--accent), var(--accent) 2px, transparent 0, transparent 10px);

     

       25
       +
             display: block;

     

       26
       +
             width: 100%;

     

       27
       +
             right: 10px;

     

       28
       +
           }

     

       29
       +
       

     

       30
       +
           a {

     

       31
       +
             flex: 0 0 auto;

     

       32
       +
             max-width: 100%;

     

       33
       +
             text-decoration: none;

     

       34
       +
           }

     

       35
       +
         }

     

       36
       +
       

     

       37
       +
         .menu {

     

       38
       +
           margin: 20px 0;

     

       39
       +
           --shadow-color: var(--accent-alpha-70);

     

       40
       +
           --shadow: 0 10px var(--shadow-color), -10px 10px var(--shadow-color), 10px 10px var(--shadow-color);

     

       41
       +
       

     

       42
       +
           @media (max-width: $tablet-max-width) {

     

       43
       +
             margin-bottom: 0;

     

       44
       +
           }

     

       45
       +
       

     

       46
       +
           &__inner {

     

       47
       +
             display: flex;

     

       48
       +
             flex-wrap: wrap;

     

       49
       +
             list-style: none;

     

       50
       +
             margin: 0;

     

       51
       +
             padding: 0;

     

       52
       +
       

     

       53
       +
             li:not(:last-of-type) {

     

       54
       +
               margin-right: 20px;

     

       55
       +
               margin-bottom: 10px;

     

       56
       +
               flex: 0 0 auto;

     

       57
       +
             }

     

       58
       +
       

     

       59
       +
             @media (max-width: $phone-max-width) {

     

       60
       +
               align-items: flex-start;

     

       61
       +
               padding: 0;

     

       62
       +
       

     

       63
       +
               li {

     

       64
       +
                 margin: 0;

     

       65
       +
                 padding: 5px;

     

       66
       +
               }

     

       67
       +
             }

     

       68
       +
           }

     

       69
       +
         }

     

       70
       +
       }

sass/_logo.scss

···

       1
       +
       .logo {

     

       2
       +
         display: flex;

     

       3
       +
         align-items: center;

     

       4
       +
         text-decoration: none;

     

       5
       +
         background: var(--accent);

     

       6
       +
         color: black;

     

       7
       +
         padding: 5px 10px;

     

       8
       +
       }

+265

sass/_main.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       :root {

     

       4
       +
         font-size: calc(1rem + 0.05vw);

     

       5
       +
         line-height: 1.54;

     

       6
       +
         color: var(--color);

     

       7
       +
       

     

       8
       +
         @media print {

     

       9
       +
           color: #000;

     

       10
       +
           line-height: 1.2;

     

       11
       +
           font-size: 10pt;

     

       12
       +
         }

     

       13
       +
       }

     

       14
       +
       

     

       15
       +
       html {

     

       16
       +
         box-sizing: border-box;

     

       17
       +
       }

     

       18
       +
       

     

       19
       +
       *,

     

       20
       +
       *:before,

     

       21
       +
       *:after {

     

       22
       +
         box-sizing: inherit;

     

       23
       +
       }

     

       24
       +
       

     

       25
       +
       body {

     

       26
       +
         margin: 0;

     

       27
       +
         padding: 0;

     

       28
       +
         font-family: ui-monospace, monospace;

     

       29
       +
         background-color: var(--background);

     

       30
       +
         // text-shadow: 0 0 3px currentcolor;

     

       31
       +
         text-rendering: optimizeLegibility;

     

       32
       +
         -webkit-font-smoothing: antialiased;

     

       33
       +
         -webkit-overflow-scrolling: touch;

     

       34
       +
         -webkit-text-size-adjust: 100%;

     

       35
       +
       }

     

       36
       +
       

     

       37
       +
       h1, h2, h3, h4, h5, h6 {

     

       38
       +
         line-height: 1.3;

     

       39
       +
       

     

       40
       +
         &:not(:first-child) {

     

       41
       +
           margin-top: 40px;

     

       42
       +
         }

     

       43
       +
       

     

       44
       +
         .zola-anchor {

     

       45
       +
           font-size: .75em;

     

       46
       +
           visibility: hidden;

     

       47
       +
           margin-left: 0.5rem;

     

       48
       +
           vertical-align: 1%;

     

       49
       +
           text-decoration: none;

     

       50
       +
           border-bottom-color: transparent;

     

       51
       +
           cursor: pointer;

     

       52
       +
           color: var(--accent);

     

       53
       +
       

     

       54
       +
           @media (hover: none){

     

       55
       +
             visibility: visible;

     

       56
       +
           }

     

       57
       +
         }

     

       58
       +
       

     

       59
       +
         &:hover {

     

       60
       +
           .zola-anchor {

     

       61
       +
             visibility: visible;

     

       62
       +
           }

     

       63
       +
         }

     

       64
       +
       }

     

       65
       +
       

     

       66
       +
       h1 {

     

       67
       +
         font-size: 1.4rem;

     

       68
       +
       }

     

       69
       +
       

     

       70
       +
       h2 {

     

       71
       +
         font-size: 1.3rem;

     

       72
       +
       }

     

       73
       +
       

     

       74
       +
       h3 {

     

       75
       +
         font-size: 1.2rem;

     

       76
       +
       }

     

       77
       +
       

     

       78
       +
       h4, h5, h6 {

     

       79
       +
         font-size: 1.15rem;

     

       80
       +
       }

     

       81
       +
       

     

       82
       +
       

     

       83
       +
       a {

     

       84
       +
         color: inherit;

     

       85
       +
       

     

       86
       +
         &:hover {

     

       87
       +
           color: var(--accent);

     

       88
       +
           text-shadow: 0 0 .25em currentcolor;

     

       89
       +
         };

     

       90
       +
       }

     

       91
       +
       

     

       92
       +
       img {

     

       93
       +
         display: block;

     

       94
       +
         max-width: 100%;

     

       95
       +
       }

     

       96
       +
       

     

       97
       +
       p {

     

       98
       +
         margin-bottom: 20px;

     

       99
       +
       }

     

       100
       +
       

     

       101
       +
       code {

     

       102
       +
         font-family: ui-monospace, monospace;

     

       103
       +
         background: var(--accent-alpha-20);

     

       104
       +
         color: var(--accent);

     

       105
       +
         padding: 1px 6px;

     

       106
       +
         margin: 0 2px;

     

       107
       +
         font-size: .95rem;

     

       108
       +
         hyphens: none;

     

       109
       +
       }

     

       110
       +
       

     

       111
       +
       pre {

     

       112
       +
         font-family: ui-monospace, monospace;

     

       113
       +
         padding: 20px 10px;

     

       114
       +
         font-size: .95rem;

     

       115
       +
         overflow: auto;

     

       116
       +
         border-top: 1px solid rgba(255, 255, 255, .1);

     

       117
       +
         border-bottom: 1px solid rgba(255, 255, 255, .1);

     

       118
       +
         position: relative;

     

       119
       +
       

     

       120
       +
         + pre {

     

       121
       +
           border-top: 0;

     

       122
       +
           margin-top: -40px;

     

       123
       +
         }

     

       124
       +
       

     

       125
       +
         @media (max-width: $phone-max-width) {

     

       126
       +
           white-space: pre-wrap;

     

       127
       +
           word-wrap: break-word;

     

       128
       +
         }

     

       129
       +
       

     

       130
       +
         &[data-lang]::before {

     

       131
       +
           content: attr(data-lang);

     

       132
       +
           display: block;

     

       133
       +
           position: absolute;

     

       134
       +
           top: 0;

     

       135
       +
           right: 0;

     

       136
       +
           padding: .2em .5em;

     

       137
       +
           font-weight: bold;

     

       138
       +
           font-size: .95rem;

     

       139
       +
           border-radius: 0 0 0 6px;

     

       140
       +
           background-color: var(--accent-alpha-20);

     

       141
       +
         }

     

       142
       +
       

     

       143
       +
         code {

     

       144
       +
           background: none !important;

     

       145
       +
           margin: 0;

     

       146
       +
           padding: 0;

     

       147
       +
           font-size: inherit;

     

       148
       +
           border: none;

     

       149
       +
         }

     

       150
       +
       }

     

       151
       +
       

     

       152
       +
       blockquote {

     

       153
       +
         border-top: 1px solid var(--accent);

     

       154
       +
         border-bottom: 1px solid var(--accent);

     

       155
       +
         margin: 40px 0;

     

       156
       +
         padding: 25px;

     

       157
       +
       

     

       158
       +
         @media (max-width: $phone-max-width) {

     

       159
       +
           padding-right: 0;

     

       160
       +
         }

     

       161
       +
       

     

       162
       +
         > :first-child {

     

       163
       +
           margin-top: 0;

     

       164
       +
           position: relative;

     

       165
       +
       

     

       166
       +
           &:before {

     

       167
       +
             content: '>';

     

       168
       +
             display: block;

     

       169
       +
             position: absolute;

     

       170
       +
             left: -25px;

     

       171
       +
             top: .1em;

     

       172
       +
             color: var(--accent);

     

       173
       +
           }

     

       174
       +
         }

     

       175
       +
       

     

       176
       +
         > :last-child {

     

       177
       +
           margin-bottom: 0;

     

       178
       +
         }

     

       179
       +
       }

     

       180
       +
       

     

       181
       +
       table {

     

       182
       +
         table-layout: fixed;

     

       183
       +
         border-collapse: collapse;

     

       184
       +
         width: 100%;

     

       185
       +
         margin: 40px 0;

     

       186
       +
       }

     

       187
       +
       

     

       188
       +
       table, th, td {

     

       189
       +
         border: 1px dashed var(--accent);

     

       190
       +
         padding: 10px;

     

       191
       +
       }

     

       192
       +
       

     

       193
       +
       th {

     

       194
       +
         color: var(--accent);

     

       195
       +
       }

     

       196
       +
       

     

       197
       +
       ul, ol {

     

       198
       +
         margin-left: 30px;

     

       199
       +
         padding: 0;

     

       200
       +
       

     

       201
       +
         li {

     

       202
       +
           padding-left: 1em;

     

       203
       +
           margin-top: 5px;

     

       204
       +
           margin-bottom: 5px;

     

       205
       +
         }

     

       206
       +
       

     

       207
       +
         @media (max-width: $phone-max-width) {

     

       208
       +
           margin-left: 20px;

     

       209
       +
         }

     

       210
       +
       

     

       211
       +
         ul, ol {

     

       212
       +
           margin-top: 10px;

     

       213
       +
           margin-bottom: 10px;

     

       214
       +
         }

     

       215
       +
       }

     

       216
       +
       

     

       217
       +
       .container {

     

       218
       +
         display: flex;

     

       219
       +
         flex-direction: column;

     

       220
       +
         padding: 40px;

     

       221
       +
         max-width: 864px;

     

       222
       +
         min-height: 100vh;

     

       223
       +
         border-right: 1px solid rgba(255, 255, 255, 0.1);

     

       224
       +
       

     

       225
       +
         &.full,

     

       226
       +
         &.center {

     

       227
       +
           border: none;

     

       228
       +
           margin: 0 auto;

     

       229
       +
         }

     

       230
       +
       

     

       231
       +
         &.full {

     

       232
       +
           max-width: 100%;

     

       233
       +
         }

     

       234
       +
       

     

       235
       +
         @media (max-width: $phone-max-width) {

     

       236
       +
           padding: 20px;

     

       237
       +
         }

     

       238
       +
       }

     

       239
       +
       

     

       240
       +
       .content {

     

       241
       +
         display: flex;

     

       242
       +
         flex-direction: column;

     

       243
       +
       }

     

       244
       +
       

     

       245
       +
       hr {

     

       246
       +
         width: 100%;

     

       247
       +
         border: none;

     

       248
       +
         background: var(--border-color);

     

       249
       +
         height: 1px;

     

       250
       +
       }

     

       251
       +
       

     

       252
       +
       ol {

     

       253
       +
         counter-reset: li;

     

       254
       +
         list-style: none;

     

       255
       +
       

     

       256
       +
         li {

     

       257
       +
           counter-increment: li;

     

       258
       +
       

     

       259
       +
           // Todo change it to ::marker when Safari will support it

     

       260
       +
           &::before {

     

       261
       +
             margin-left: -2rem;

     

       262
       +
             content: counters(li, ".") ". ";

     

       263
       +
           }

     

       264
       +
         }

     

       265
       +
       }

+81

sass/_pagination.scss

···

       1
       +
       @import 'variables';

     

       2
       +
       

     

       3
       +
       .pagination {

     

       4
       +
         margin-top: 50px;

     

       5
       +
       

     

       6
       +
         &__title {

     

       7
       +
           display: flex;

     

       8
       +
           text-align: center;

     

       9
       +
           position: relative;

     

       10
       +
           margin: 100px 0 20px;

     

       11
       +
       

     

       12
       +
           &-h {

     

       13
       +
             text-align: center;

     

       14
       +
             margin: 0 auto;

     

       15
       +
             padding: 5px 10px;

     

       16
       +
             background: var(--background);

     

       17
       +
             font-size: .8rem;

     

       18
       +
             text-transform: uppercase;

     

       19
       +
             letter-spacing: .1em;

     

       20
       +
             z-index: 1;

     

       21
       +
           }

     

       22
       +
       

     

       23
       +
           hr {

     

       24
       +
             position: absolute;

     

       25
       +
             left: 0;

     

       26
       +
             right: 0;

     

       27
       +
             width: 100%;

     

       28
       +
             margin-top: 15px;

     

       29
       +
             z-index: 0;

     

       30
       +
           }

     

       31
       +
         }

     

       32
       +
       

     

       33
       +
         &__buttons {

     

       34
       +
           display: flex;

     

       35
       +
           align-items: center;

     

       36
       +
           justify-content: center;

     

       37
       +
       

     

       38
       +
           a {

     

       39
       +
               text-decoration: none;

     

       40
       +
           }

     

       41
       +
         }

     

       42
       +
       }

     

       43
       +
       

     

       44
       +
       .button {

     

       45
       +
         position: relative;

     

       46
       +
         display: inline-flex;

     

       47
       +
         align-items: center;

     

       48
       +
         justify-content: center;

     

       49
       +
         border-radius: 8px;

     

       50
       +
         max-width: 40%;

     

       51
       +
         padding: 0;

     

       52
       +
         cursor: pointer;

     

       53
       +
         appearance: none;

     

       54
       +
       

     

       55
       +
         + .button {

     

       56
       +
             margin-left: 10px;

     

       57
       +
         }

     

       58
       +
       

     

       59
       +
         a {

     

       60
       +
           display: flex;

     

       61
       +
           padding: 8px 16px;

     

       62
       +
           text-decoration: none;

     

       63
       +
           text-overflow: ellipsis;

     

       64
       +
           white-space: nowrap;

     

       65
       +
           overflow: hidden;

     

       66
       +
         }

     

       67
       +
       

     

       68
       +
         &__text {

     

       69
       +
           text-overflow: ellipsis;

     

       70
       +
           white-space: nowrap;

     

       71
       +
           overflow: hidden;

     

       72
       +
         }

     

       73
       +
       

     

       74
       +
         &.next .button__icon {

     

       75
       +
           margin-left: 8px;

     

       76
       +
         }

     

       77
       +
       

     

       78
       +
         &.previous .button__icon {

     

       79
       +
           margin-right: 8px;

     

       80
       +
         }

     

       81
       +
       }

+198

sass/_post.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       .post {

     

       4
       +
         width: 100%;

     

       5
       +
         text-align: justify;

     

       6
       +
         text-wrap: pretty;

     

       7
       +
         hyphens: auto;

     

       8
       +
         hyphenate-limit-chars: 10;

     

       9
       +
         margin: 20px auto;

     

       10
       +
         padding: 20px 0 0 0;

     

       11
       +
       

     

       12
       +
       

     

       13
       +
         @media (max-width: $tablet-max-width) {

     

       14
       +
           margin: 0 auto;

     

       15
       +
           max-width: 660px;

     

       16
       +
         }

     

       17
       +
       

     

       18
       +
         &:first-of-type {

     

       19
       +
           padding-top: 0;

     

       20
       +
         }

     

       21
       +
       

     

       22
       +
         &:not(:last-of-type) {

     

       23
       +
           border-bottom: 1px solid var(--border-color);

     

       24
       +
         }

     

       25
       +
       

     

       26
       +
         &-meta {

     

       27
       +
           margin-bottom: 10px;

     

       28
       +
           color: var(--accent-alpha-70);

     

       29
       +
           a { text-decoration: none; }

     

       30
       +
           a:hover { text-decoration: underline; }

     

       31
       +
         }

     

       32
       +
       

     

       33
       +
         &-title {

     

       34
       +
           --border: 3px dotted var(--accent);

     

       35
       +
           position: relative;

     

       36
       +
           color: var(--accent);

     

       37
       +
           margin: 0 0 15px;

     

       38
       +
           padding-bottom: 15px;

     

       39
       +
           border-bottom: var(--border);

     

       40
       +
       

     

       41
       +
           &:after {

     

       42
       +
             content: '';

     

       43
       +
             position: absolute;

     

       44
       +
             bottom: 2px;

     

       45
       +
             display: block;

     

       46
       +
             width: 100%;

     

       47
       +
             border-bottom: var(--border);

     

       48
       +
           }

     

       49
       +
       

     

       50
       +
           a {

     

       51
       +
             text-decoration: none;

     

       52
       +
           }

     

       53
       +
         }

     

       54
       +
       

     

       55
       +
         &.on-list &-title { --border: none; }

     

       56
       +
       

     

       57
       +
         &-tags {

     

       58
       +
           display: block;

     

       59
       +
           margin-bottom: 20px;

     

       60
       +
           opacity: .5;

     

       61
       +
       

     

       62
       +
           a {

     

       63
       +
               text-decoration: none;

     

       64
       +
           }

     

       65
       +
         }

     

       66
       +
       

     

       67
       +
         &-content {

     

       68
       +
           margin-top: 30px;

     

       69
       +
         }

     

       70
       +
       

     

       71
       +
         &-cover {

     

       72
       +
           border: 20px solid var(--accent);

     

       73
       +
           background: transparent;

     

       74
       +
           margin: 40px 0;

     

       75
       +
           padding: 20px;

     

       76
       +
       

     

       77
       +
           @media (max-width: $phone-max-width) {

     

       78
       +
             padding: 10px;

     

       79
       +
             border-width: 10px;

     

       80
       +
           }

     

       81
       +
         }

     

       82
       +
       

     

       83
       +
         ul {

     

       84
       +
           list-style: "\29bf";

     

       85
       +
       

     

       86
       +
           ul {

     

       87
       +
             list-style: "\25a0";

     

       88
       +
       

     

       89
       +
             ul { list-style: "\25ba"; }

     

       90
       +
           }

     

       91
       +
         }

     

       92
       +
       }

     

       93
       +
       

     

       94
       +
       // TODO: try adapting this using a properly nested selector in the block above

     

       95
       +
       //       for ul items.

     

       96
       +
       .tag-list {

     

       97
       +
           @media(max-width: $phone-max-width) {

     

       98
       +
               margin-left: 5%;

     

       99
       +
           }

     

       100
       +
       }

     

       101
       +
       

     

       102
       +
       .post--regulation {

     

       103
       +
         h1 {

     

       104
       +
           justify-content: center;

     

       105
       +
         }

     

       106
       +
       

     

       107
       +
         h2 {

     

       108
       +
           justify-content: center;

     

       109
       +
           margin-bottom: 10px;

     

       110
       +
       

     

       111
       +
           &+ h2 {

     

       112
       +
             margin-top: -10px;

     

       113
       +
             margin-bottom: 20px;

     

       114
       +
           }

     

       115
       +
         }

     

       116
       +
       }

     

       117
       +
       

     

       118
       +
       .post-list {

     

       119
       +
         .post-date {

     

       120
       +
           color: var(--accent-alpha-70);

     

       121
       +
           text-decoration: none;

     

       122
       +
         }

     

       123
       +
       

     

       124
       +
         a {

     

       125
       +
           text-decoration: none;

     

       126
       +
         }

     

       127
       +
       }

     

       128
       +
       

     

       129
       +
       .post-toc {

     

       130
       +
         font-size: .8rem;

     

       131
       +
       

     

       132
       +
         .toggleable { display: none; }

     

       133
       +
       

     

       134
       +
         label {

     

       135
       +
           color: var(--accent-alpha-70);

     

       136
       +
           -webkit-user-select: none; /* Safari */

     

       137
       +
           -ms-user-select: none; /* IE 10 and IE 11 */

     

       138
       +
           user-select: none; /* Standard syntax */

     

       139
       +
         }

     

       140
       +
         label::before { content: '>'; margin-right: 1rem; }

     

       141
       +
       

     

       142
       +
         input[type="checkbox"]:checked {

     

       143
       +
           & ~ .toggleable { display: block; }

     

       144
       +
           & ~ label::before { content: 'v'; }

     

       145
       +
         }

     

       146
       +
       

     

       147
       +
         a { text-decoration: none; }

     

       148
       +
       

     

       149
       +
         a:hover { text-decoration: underline; }

     

       150
       +
       }

     

       151
       +
       

     

       152
       +
       .for-hire {

     

       153
       +
         @media print {

     

       154
       +
           display: none;

     

       155
       +
         }

     

       156
       +
       

     

       157
       +
         width: 100%;

     

       158
       +
         text-align: center;

     

       159
       +
         font-weight: bolder;

     

       160
       +
       

     

       161
       +
         border: 1px white solid;

     

       162
       +
         padding: 1em;

     

       163
       +
         margin: 2em 0;

     

       164
       +
       }

     

       165
       +
       

     

       166
       +
       .webmentions .url-only {

     

       167
       +
         line-break: anywhere;

     

       168
       +
       }

     

       169
       +
       

     

       170
       +
       .halmos {

     

       171
       +
         text-align: right;

     

       172
       +
         font-size: 1.5em;

     

       173
       +
       }

     

       174
       +
       

     

       175
       +
       .footnote-definition {

     

       176
       +
         @media (min-width: #{$tablet-max-width + 1px}) {

     

       177
       +
           position: absolute;

     

       178
       +
           left: 105%;

     

       179
       +
       

     

       180
       +
           width: 10vw;

     

       181
       +
       

     

       182
       +
           margin-top: -7rem;

     

       183
       +
         }

     

       184
       +
       

     

       185
       +
         margin-top: 1rem;

     

       186
       +
       

     

       187
       +
         font-size: .8em;

     

       188
       +
       

     

       189
       +
         p {

     

       190
       +
           padding-left: .5rem;

     

       191
       +
           display: inline;

     

       192
       +
         }

     

       193
       +
       

     

       194
       +
         // For some reason `:last-of-type` doesn't work

     

       195
       +
         &:has(+ .halmos) {

     

       196
       +
           margin-bottom: -.5rem;

     

       197
       +
         }

     

       198
       +
       }

+40

sass/_rings.scss

···

       1
       +
       .rings {

     

       2
       +
         margin-top: 1rem;

     

       3
       +
         text-align: center;

     

       4
       +
       

     

       5
       +
         details > summary {

     

       6
       +
           list-style: none;

     

       7
       +
           cursor: pointer;

     

       8
       +
       

     

       9
       +
           &::before, &::after {

     

       10
       +
             margin: 0 .5rem;

     

       11
       +
           }

     

       12
       +
       

     

       13
       +
           &::before { content: '▶'; }

     

       14
       +
           &::after { content: '◀'; }

     

       15
       +
       

     

       16
       +
           &::-webkit-details-marker {

     

       17
       +
             display: none;

     

       18
       +
           }

     

       19
       +
         }

     

       20
       +
       

     

       21
       +
         details[open] {

     

       22
       +
           summary {

     

       23
       +
             &::before, &::after {

     

       24
       +
               content: '▼';

     

       25
       +
             }

     

       26
       +
       

     

       27
       +
             margin-bottom: 1rem;

     

       28
       +
           }

     

       29
       +
         }

     

       30
       +
       

     

       31
       +
         ul {

     

       32
       +
           list-style: none;

     

       33
       +
           margin: 0;

     

       34
       +
         }

     

       35
       +
       

     

       36
       +
         li {

     

       37
       +
           margin: 0;

     

       38
       +
           padding: 0;

     

       39
       +
         }

     

       40
       +
       }

sass/_variables.scss

···

       1
       +
       $phone-max-width: 683px;

     

       2
       +
       $tablet-max-width: 1199px;

+22

sass/feed.scss

···

       1
       +
       body {

     

       2
       +
         color: #222;

     

       3
       +
         font-family: apple-system, system-ui, sans-serif;

     

       4
       +
       }

     

       5
       +
       .container {

     

       6
       +
         align-item: center;

     

       7
       +
         display: flex;

     

       8
       +
         justify-content: center;

     

       9
       +
       }

     

       10
       +
       .item {

     

       11
       +
         max-width: 768px;

     

       12
       +
       }

     

       13
       +
       a {

     

       14
       +
         color: #4166f5;

     

       15
       +
         text-decoration: none;

     

       16
       +
       }

     

       17
       +
       a:visited {

     

       18
       +
         color: #3f00ff;

     

       19
       +
       }

     

       20
       +
       a:hover {

     

       21
       +
         text-decoration: underline;

     

       22
       +
       }

+14

sass/style.scss

···

       1
       +
       @import 'variables';

     

       2
       +
       @import 'buttons';

     

       3
       +
       @import 'header';

     

       4
       +
       @import 'logo';

     

       5
       +
       @import 'main';

     

       6
       +
       @import 'post';

     

       7
       +
       @import 'pagination';

     

       8
       +
       @import 'footer';

     

       9
       +
       @import 'rings';

     

       10
       +
       

     

       11
       +
       :root {

     

       12
       +
         --phoneWidth: (max-width: #{$phone-max-width + 1px});

     

       13
       +
         --tabletWidth: (max-width: #{$tablet-max-width + 1px});

     

       14
       +
       }

-10

shell.nix

···

       1
       -
       { pkgs ? import <nixpkgs> {}, ... }:

     

       2
       -
       

     

       3
       -
       let

     

       4
       -
         blog = import ./. {};

     

       5
       -
       in

     

       6
       -
         pkgs.mkShell {

     

       7
       -
           buildInputs = [

     

       8
       -
             blog.zola

     

       9
       -
           ];

     

       10
       -
         }

static/_headers

···

       1
       +
       *

     

       2
       +
         Permission-Policy: interest-cohort=()

     

       3
       +
         X-Frame-Options: DENY

     

       4
       +
         X-XSS-Protection: 1; mode=block

     

       5
       +
         X-Clacks-Overhead: GNU Terry Pratchet

     

       6
       +
         X-Clacks-Overhead: GNU Joe Armstrong

     

       7
       +
         Content-Security-Policy: default-src 'self'; script-src 'self'; connect-src 'self'; img-src 'self'; frame-src 'none'; frame-ancestors 'none'; form-action 'none'; base-uri 'self';

     

       8
       +
         Permissions-Policy: accelerometer=(), ambient-light-sensor=(), autoplay=(), battery=(), camera=(), cross-origin-isolated=(), display-capture=(), document-domain=(), encrypted-media=(), execution-while-not-rendered=(), execution-while-out-of-viewport=(), fullscreen=(), geolocation=(), gyroscope=(), keyboard-map=(), magnetometer=(), microphone=(), midi=(), navigation-override=(), payment=(), picture-in-picture=(), publickey-credentials-get=(), screen-wake-lock=(), sync-xhr=(), usb=(), web-share=(), xr-spatial-tracking=(), clipboard-read=(), clipboard-write=(), gamepad=(), speaker-selection=()

     

       9
       +
         Referrer-Policy: strict-origin-when-cross-origin

static/_redirects

···

       1
       +
       /js/script.js https://plausible.io/js/script.js 200

     

       2
       +
       /api/event https://plausible.io/api/event 200

     

       3
       +
       /.well-known/webfinger https://fosstodon.org/.well-known/webfinger?resource=acct:hauleth@fosstodon.org 200

static/android-chrome-192x192.png

This is a binary file and will not be displayed.

static/android-chrome-512x512.png

This is a binary file and will not be displayed.

static/apple-touch-icon.png

This is a binary file and will not be displayed.

+58

static/atom-style.xml

···

       1
       +
       <?xml version="1.0" encoding="utf-8"?>

     

       2
       +
       <xsl:stylesheet version="3.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd">

     

       3
       +
         <xsl:output method="html" encoding="UTF-8" />

     

       4
       +
         <xsl:template match="/atom:feed">

     

       5
       +
           <html lang="en" dir="ltr">

     

       6
       +
             <head>

     

       7
       +
               <title><xsl:value-of select="atom:title"/> - RSS Feed</title>

     

       8
       +
               <meta charset="UTF-8" />

     

       9
       +
               <meta http-equiv="x-ua-compatible" content="IE=edge,chrome=1" />

     

       10
       +
               <meta http-equiv="content-language" content="en_US" />

     

       11
       +
               <meta name="viewport" content="width=device-width,minimum-scale=1,initial-scale=1,shrink-to-fit=no" />

     

       12
       +
               <meta name="referrer" content="none" />

     

       13
       +
       

     

       14
       +
               <!-- FAVICONS CAN GO HERE -->

     

       15
       +
               <link href="/feed.css" rel="stylesheet" />

     

       16
       +
             </head>

     

       17
       +
             <body>

     

       18
       +
               <div class="container">

     

       19
       +
                 <div class="item">

     

       20
       +
                   <header>

     

       21
       +
                     <h1>RSS Feed</h1>

     

       22
       +
                     <h2>

     

       23
       +
                       <xsl:value-of select="atom:title"/>

     

       24
       +
                     </h2>

     

       25
       +
                     <p>

     

       26
       +
                       <xsl:value-of select="atom:subtitle"/>

     

       27
       +
                     </p>

     

       28
       +
                     <a hreflang="en" target="_blank">

     

       29
       +
                       <xsl:attribute name="href">

     

       30
       +
                         <xsl:value-of select="atom:link[@rel='related']/@href"/>

     

       31
       +
                       </xsl:attribute>

     

       32
       +
                         Visit Website &#x2192;

     

       33
       +
                     </a>

     

       34
       +
                   </header>

     

       35
       +
                   <main>

     

       36
       +
                     <h2>Recent Posts</h2>

     

       37
       +
                     <xsl:for-each select="atom:entry">

     

       38
       +
                       <article>

     

       39
       +
                         <h3>

     

       40
       +
                           <a hreflang="en" target="_blank">

     

       41
       +
                             <xsl:attribute name="href">

     

       42
       +
                               <xsl:value-of select="atom:link/@href"/>

     

       43
       +
                             </xsl:attribute>

     

       44
       +
                             <xsl:value-of select="atom:title"/>

     

       45
       +
                           </a>

     

       46
       +
                         </h3>

     

       47
       +
                         <p>

     

       48
       +
                           <xsl:value-of select="atom:summary"/>

     

       49
       +
                         </p>

     

       50
       +
                       </article>

     

       51
       +
                     </xsl:for-each>

     

       52
       +
                   </main>

     

       53
       +
                 </div>

     

       54
       +
               </div>

     

       55
       +
             </body>

     

       56
       +
           </html>

     

       57
       +
         </xsl:template>

     

       58
       +
       </xsl:stylesheet>

static/favicon-16x16.png

This is a binary file and will not be displayed.

static/favicon-32x32.png

This is a binary file and will not be displayed.

static/favicon-48x48.png

This is a binary file and will not be displayed.

static/favicon.ico

This is a binary file and will not be displayed.

+17

static/favicon.svg

···

       1
       +
       <?xml version="1.0" encoding="UTF-8" standalone="no"?>

     

       2
       +
       <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">

     

       3
       +
       <svg width="100%" height="100%" viewBox="0 0 32 32" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-miterlimit:2;">

     

       4
       +
           <g transform="matrix(1,0,0,1,-16,0)">

     

       5
       +
               <g transform="matrix(2.62238,0,0,1.40473,7.10543e-15,1.77636e-15)">

     

       6
       +
                   <rect x="0" y="0" width="24.405" height="22.78" style="fill:rgb(35,176,255);"/>

     

       7
       +
               </g>

     

       8
       +
               <g id="Lambda" transform="matrix(1,0,0,1,16,0)">

     

       9
       +
                   <g transform="matrix(1,0,0,1,4.43135,0)">

     

       10
       +
                       <path d="M2.644,26.033L5.977,26.033L15.556,5.994L18.545,5.994" style="fill:none;stroke:black;stroke-width:3px;"/>

     

       11
       +
                   </g>

     

       12
       +
                   <g transform="matrix(0.990948,-0.019459,-0.019459,0.958168,4.84334,0.885678)">

     

       13
       +
                       <path d="M19.831,26.648L16.814,26.587L10.763,16.007" style="fill:none;stroke:black;stroke-width:3.14px;"/>

     

       14
       +
                   </g>

     

       15
       +
               </g>

     

       16
       +
           </g>

     

       17
       +
       </svg>

static/img/common-test/log.png

This is a binary file and will not be displayed.

static/img/treachery-of-images.jpg

This is a binary file and will not be displayed.

static/img/vim-session.png

This is a binary file and will not be displayed.

+19

static/site.webmanifest

···

       1
       +
       {

     

       2
       +
         "name": "Hauleth's blog",

     

       3
       +
         "short_name": "Hauleth's blog",

     

       4
       +
         "icons": [

     

       5
       +
           {

     

       6
       +
             "src": "/android-chrome-192x192.png",

     

       7
       +
             "sizes": "192x192",

     

       8
       +
             "type": "image/png"

     

       9
       +
           },

     

       10
       +
           {

     

       11
       +
             "src": "/android-chrome-512x512.png",

     

       12
       +
             "sizes": "512x512",

     

       13
       +
             "type": "image/png"

     

       14
       +
           }

     

       15
       +
         ],

     

       16
       +
         "theme_color": "#ffffff",

     

       17
       +
         "background_color": "#ffffff",

     

       18
       +
         "display": "standalone"

     

       19
       +
       }

+441

static/syntax-theme.css

···

       1
       +
       /*

     

       2
       +
        * theme "Nord" generated by syntect

     

       3
       +
        */

     

       4
       +
       

     

       5
       +
       .z-code {

     

       6
       +
        color: #d8dee9;

     

       7
       +
        background-color: #2e3440;

     

       8
       +
       }

     

       9
       +
       

     

       10
       +
       .z-comment, .z-punctuation.z-definition.z-comment {

     

       11
       +
        color: #616e88;

     

       12
       +
       }

     

       13
       +
       .z-constant.z-numeric {

     

       14
       +
        color: #b48ead;

     

       15
       +
       }

     

       16
       +
       .z-constant.z-language {

     

       17
       +
        color: #81a1c1;

     

       18
       +
       }

     

       19
       +
       .z-constant.z-character.z-escape {

     

       20
       +
        color: #ebcb8b;

     

       21
       +
       }

     

       22
       +
       .z-constant.z-other.z-placeholder {

     

       23
       +
        color: #ebcb8b;

     

       24
       +
       }

     

       25
       +
       .z-constant.z-other {

     

       26
       +
        color: #d8dee9;

     

       27
       +
       }

     

       28
       +
       .z-entity.z-name.z-class {

     

       29
       +
        color: #8fbcbb;

     

       30
       +
       }

     

       31
       +
       .z-entity.z-name.z-struct {

     

       32
       +
        color: #8fbcbb;

     

       33
       +
       }

     

       34
       +
       .z-entity.z-name.z-enum {

     

       35
       +
        color: #8fbcbb;

     

       36
       +
       }

     

       37
       +
       .z-entity.z-name.z-union {

     

       38
       +
        color: #8fbcbb;

     

       39
       +
       }

     

       40
       +
       .z-entity.z-name.z-trait {

     

       41
       +
        color: #8fbcbb;

     

       42
       +
       }

     

       43
       +
       .z-entity.z-name.z-interface {

     

       44
       +
        color: #8fbcbb;

     

       45
       +
       font-weight: bold;

     

       46
       +
       }

     

       47
       +
       .z-entity.z-name.z-type {

     

       48
       +
        color: #81a1c1;

     

       49
       +
       }

     

       50
       +
       .z-entity.z-other.z-inherited-class {

     

       51
       +
        color: #8fbcbb;

     

       52
       +
       }

     

       53
       +
       .z-entity.z-name.z-function {

     

       54
       +
        color: #88c0d0;

     

       55
       +
       }

     

       56
       +
       .z-entity.z-name.z-function.z-constructor {

     

       57
       +
        color: #88c0d0;

     

       58
       +
       }

     

       59
       +
       .z-entity.z-name.z-function.z-destructor {

     

       60
       +
        color: #88c0d0;

     

       61
       +
       }

     

       62
       +
       .z-entity.z-name.z-namespace {

     

       63
       +
        color: #8fbcbb;

     

       64
       +
       }

     

       65
       +
       .z-entity.z-name.z-constant {

     

       66
       +
        color: #81a1c1;

     

       67
       +
       }

     

       68
       +
       .z-entity.z-name.z-label {

     

       69
       +
        color: #5e81ac;

     

       70
       +
       }

     

       71
       +
       .z-entity.z-name.z-section {

     

       72
       +
        color: #88c0d0;

     

       73
       +
       }

     

       74
       +
       .z-entity.z-name.z-tag {

     

       75
       +
        color: #81a1c1;

     

       76
       +
       }

     

       77
       +
       .z-entity.z-other.z-attribute-name {

     

       78
       +
        color: #8fbcbb;

     

       79
       +
       }

     

       80
       +
       .z-invalid.z-illegal {

     

       81
       +
        color: #d8dee9;

     

       82
       +
        background-color: #bf616a;

     

       83
       +
       }

     

       84
       +
       .z-invalid.z-deprecated {

     

       85
       +
        color: #d8dee9;

     

       86
       +
        background-color: #ebcb8b;

     

       87
       +
       }

     

       88
       +
       .z-keyword.z-control {

     

       89
       +
        color: #81a1c1;

     

       90
       +
       }

     

       91
       +
       .z-keyword.z-control.z-conditional {

     

       92
       +
        color: #81a1c1;

     

       93
       +
       }

     

       94
       +
       .z-keyword.z-control.z-import {

     

       95
       +
        color: #81a1c1;

     

       96
       +
       }

     

       97
       +
       .z-punctuation.z-definition.z-keyword {

     

       98
       +
        color: #81a1c1;

     

       99
       +
       }

     

       100
       +
       .z-keyword.z-other {

     

       101
       +
        color: #81a1c1;

     

       102
       +
       }

     

       103
       +
       .z-keyword.z-operator, .z-keyword.z-operator.z-assignment, .z-keyword.z-operator.z-arithmetic, .z-keyword.z-operator.z-bitwise, .z-keyword.z-operator.z-logical, .z-keyword.z-operator.z-word {

     

       104
       +
        color: #81a1c1;

     

       105
       +
       }

     

       106
       +
       .z-markup.z-heading {

     

       107
       +
        color: #88c0d0;

     

       108
       +
       }

     

       109
       +
       .z-markup.z-list.z-unnumbered, .z-markup.z-list.z-numbered {

     

       110
       +
        color: #d8dee9;

     

       111
       +
       }

     

       112
       +
       .z-markup.z-bold {

     

       113
       +
       font-weight: bold;

     

       114
       +
       }

     

       115
       +
       .z-markup.z-italic {

     

       116
       +
       font-style: italic;

     

       117
       +
       }

     

       118
       +
       .z-markup.z-inserted {

     

       119
       +
        color: #a3be8c;

     

       120
       +
       }

     

       121
       +
       .z-markup.z-deleted {

     

       122
       +
        color: #bf616a;

     

       123
       +
       }

     

       124
       +
       .z-markup.z-changed {

     

       125
       +
        color: #ebcb8b;

     

       126
       +
       }

     

       127
       +
       .z-markup.z-quote {

     

       128
       +
        color: #616e88;

     

       129
       +
       }

     

       130
       +
       .z-markup.z-raw.z-inline, .z-markup.z-raw.z-block {

     

       131
       +
        color: #8fbcbb;

     

       132
       +
       }

     

       133
       +
       .z-markup.z-other {

     

       134
       +
        background-color: #eceff4;

     

       135
       +
       }

     

       136
       +
       .z-punctuation.z-separator, .z-punctuation.z-terminator {

     

       137
       +
        color: #eceff4;

     

       138
       +
       }

     

       139
       +
       .z-punctuation.z-separator.z-continuation, .z-punctuation.z-accessor {

     

       140
       +
        color: #81a1c1;

     

       141
       +
       }

     

       142
       +
       .z-punctuation.z-definition.z-tag {

     

       143
       +
        color: #81a1c1;

     

       144
       +
       }

     

       145
       +
       .z-storage.z-type, .z-storage.z-modifier {

     

       146
       +
        color: #81a1c1;

     

       147
       +
       }

     

       148
       +
       .z-string.z-quoted.z-single, .z-string.z-quoted.z-double, .z-string.z-quoted.z-triple, .z-string.z-quoted.z-other, .z-string.z-unquoted {

     

       149
       +
        color: #a3be8c;

     

       150
       +
       }

     

       151
       +
       .z-punctuation.z-definition.z-string.z-begin, .z-punctuation.z-definition.z-string.z-end {

     

       152
       +
        color: #a3be8c;

     

       153
       +
       }

     

       154
       +
       .z-string.z-regexp {

     

       155
       +
        color: #ebcb8b;

     

       156
       +
       }

     

       157
       +
       .z-support.z-constant {

     

       158
       +
        color: #8fbcbb;

     

       159
       +
       }

     

       160
       +
       .z-support.z-function {

     

       161
       +
        color: #88c0d0;

     

       162
       +
       }

     

       163
       +
       .z-support.z-module {

     

       164
       +
        color: #8fbcbb;

     

       165
       +
       }

     

       166
       +
       .z-support.z-type {

     

       167
       +
        color: #8fbcbb;

     

       168
       +
       }

     

       169
       +
       .z-support.z-class {

     

       170
       +
        color: #8fbcbb;

     

       171
       +
       }

     

       172
       +
       .z-text.z-html.z-basic, .z-text.z-xml {

     

       173
       +
        color: #eceff4;

     

       174
       +
       }

     

       175
       +
       .z-variable.z-other, .z-variable.z-other.z-readwrite {

     

       176
       +
        color: #d8dee9;

     

       177
       +
       }

     

       178
       +
       .z-punctuation.z-definition.z-variable {

     

       179
       +
        color: #81a1c1;

     

       180
       +
       }

     

       181
       +
       .z-variable.z-other.z-constant {

     

       182
       +
        color: #81a1c1;

     

       183
       +
       }

     

       184
       +
       .z-variable.z-language {

     

       185
       +
        color: #81a1c1;

     

       186
       +
       }

     

       187
       +
       .z-variable.z-parameter {

     

       188
       +
        color: #d8dee9;

     

       189
       +
       }

     

       190
       +
       .z-variable.z-other.z-member {

     

       191
       +
        color: #d8dee9;

     

       192
       +
       }

     

       193
       +
       .z-variable.z-function {

     

       194
       +
        color: #88c0d0;

     

       195
       +
       }

     

       196
       +
       .z-constant.z-numeric.z-line-number.z-find-in-files {

     

       197
       +
        color: #d8dee9;

     

       198
       +
       }

     

       199
       +
       .z-constant.z-numeric.z-line-number.z-match.z-find-in-files {

     

       200
       +
        color: #88c0d0;

     

       201
       +
       }

     

       202
       +
       .z-entity.z-name.z-filename.z-find-in-files {

     

       203
       +
        color: #8fbcbb;

     

       204
       +
       }

     

       205
       +
       .z-text.z-find-in-files {

     

       206
       +
        color: #d8dee9;

     

       207
       +
       }

     

       208
       +
       .z-source.z-c .z-keyword.z-control.z-import.z-include.z-c, .z-source.z-c .z-meta.z-preprocessor.z-c .z-keyword.z-control.z-import.z-c, .z-source.z-c++ .z-keyword.z-control.z-import.z-include.z-c++, .z-source.z-c++ .z-meta.z-preprocessor.z-c++ .z-keyword.z-control.z-import.z-c++ {

     

       209
       +
        color: #5e81ac;

     

       210
       +
       }

     

       211
       +
       .z-source.z-c .z-keyword.z-operator.z-word.z-c, .z-source.z-c++ .z-keyword.z-operator.z-word.z-c++ {

     

       212
       +
        color: #88c0d0;

     

       213
       +
       font-style: italic;

     

       214
       +
       }

     

       215
       +
       .z-source.z-css .z-support.z-type.z-property-name.z-css, .z-source.z-sass .z-support.z-type.z-property-name.z-sass, .z-source.z-css .z-support.z-type.z-vendor-prefix.z-css {

     

       216
       +
        color: #d8dee9;

     

       217
       +
       }

     

       218
       +
       .z-source.z-css .z-constant.z-other.z-color.z-rgb-value.z-css, .z-source.z-sass .z-constant.z-other.z-rgb-value.z-sass {

     

       219
       +
        color: #b48ead;

     

       220
       +
       }

     

       221
       +
       .z-source.z-css .z-support.z-constant.z-color.z-w3c-special-color-keyword.z-css, .z-source.z-css .z-support.z-constant.z-property-value.z-css, .z-source.z-sass .z-support.z-constant.z-property-value.z-sass {

     

       222
       +
        color: #81a1c1;

     

       223
       +
       }

     

       224
       +
       .z-source.z-css .z-entity.z-other.z-pseudo-class.z-css {

     

       225
       +
        color: #8fbcbb;

     

       226
       +
       }

     

       227
       +
       .z-source.z-css .z-keyword.z-control.z-at-rule.z-media.z-css, .z-source.z-css .z-punctuation.z-definition.z-keyword.z-css, .z-source.z-sass .z-keyword.z-control.z-at-rule.z-sass {

     

       228
       +
        color: #d08770;

     

       229
       +
       }

     

       230
       +
       .z-source.z-css .z-support.z-constant.z-color.z-w3c-standard-color-name.z-css {

     

       231
       +
        color: #81a1c1;

     

       232
       +
       font-style: italic;

     

       233
       +
       }

     

       234
       +
       .z-source.z-css .z-entity.z-other.z-attribute-name.z-id.z-css, .z-source.z-sass .z-entity.z-other.z-attribute-name.z-id.z-sass {

     

       235
       +
       font-weight: bold;

     

       236
       +
       }

     

       237
       +
       .z-source.z-diff .z-meta.z-diff.z-range.z-context {

     

       238
       +
        color: #8fbcbb;

     

       239
       +
       }

     

       240
       +
       .z-source.z-diff .z-meta.z-diff.z-header.z-from-file {

     

       241
       +
        color: #8fbcbb;

     

       242
       +
       }

     

       243
       +
       .z-source.z-diff .z-punctuation.z-definition.z-from-file {

     

       244
       +
        color: #8fbcbb;

     

       245
       +
       }

     

       246
       +
       .z-source.z-diff .z-punctuation.z-definition.z-separator {

     

       247
       +
        color: #81a1c1;

     

       248
       +
       }

     

       249
       +
       .z-source.z-go .z-support.z-function.z-builtin.z-go {

     

       250
       +
       font-style: italic;

     

       251
       +
       }

     

       252
       +
       .z-text.z-html.z-basic .z-constant.z-character.z-entity.z-html {

     

       253
       +
        color: #ebcb8b;

     

       254
       +
       }

     

       255
       +
       .z-variable.z-annotation.z-java, .z-punctuation.z-definition.z-annotation.z-java {

     

       256
       +
        color: #d08770;

     

       257
       +
       }

     

       258
       +
       .z-punctuation.z-accessor.z-dot.z-java {

     

       259
       +
        color: #eceff4;

     

       260
       +
       }

     

       261
       +
       .z-support.z-other.z-package.z-java {

     

       262
       +
        color: #8fbcbb;

     

       263
       +
       }

     

       264
       +
       .z-source.z-java .z-comment.z-block.z-documentation.z-javadoc .z-punctuation.z-definition.z-entity.z-html {

     

       265
       +
        color: #81a1c1;

     

       266
       +
       }

     

       267
       +
       .z-source.z-java .z-entity.z-name.z-constant {

     

       268
       +
        color: #d8dee9;

     

       269
       +
       }

     

       270
       +
       .z-source.z-java .z-keyword.z-other.z-documentation, .z-source.z-java .z-comment.z-block.z-documentation.z-javadoc .z-punctuation.z-definition.z-keyword.z-javadoc {

     

       271
       +
        color: #8fbcbb;

     

       272
       +
       }

     

       273
       +
       .z-source.z-java .z-variable.z-parameter.z-type.z-java {

     

       274
       +
        color: #8fbcbb;

     

       275
       +
       }

     

       276
       +
       .z-source.z-java .z-entity.z-other.z-inherited-class.z-java {

     

       277
       +
        color: #8fbcbb;

     

       278
       +
       font-weight: bold;

     

       279
       +
       }

     

       280
       +
       .z-source.z-java .z-keyword.z-declaration.z-implements.z-java {

     

       281
       +
        color: #81a1c1;

     

       282
       +
       }

     

       283
       +
       .z-source.z-json .z-meta.z-structure.z-dictionary.z-json .z-meta.z-structure.z-dictionary.z-key.z-json .z-string.z-quoted.z-double.z-json, .z-source.z-json.z-sublime .z-meta.z-structure.z-dictionary.z-json .z-meta.z-structure.z-dictionary.z-key.z-json .z-string.z-quoted.z-double.z-json {

     

       284
       +
        color: #8fbcbb;

     

       285
       +
       }

     

       286
       +
       .z-source.z-json .z-meta.z-structure.z-dictionary.z-json .z-punctuation.z-definition.z-string.z-begin.z-json, .z-source.z-json .z-meta.z-structure.z-dictionary.z-json .z-punctuation.z-definition.z-string.z-end.z-json, .z-source.z-json.z-sublime .z-meta.z-structure.z-dictionary.z-json .z-punctuation.z-definition.z-string.z-begin.z-json, .z-source.z-json.z-sublime .z-meta.z-structure.z-dictionary.z-json .z-punctuation.z-definition.z-string.z-end.z-json {

     

       287
       +
        color: #eceff4;

     

       288
       +
       }

     

       289
       +
       .z-text.z-html.z-markdown .z-punctuation.z-definition.z-raw.z-code-fence.z-begin.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-definition.z-raw.z-code-fence.z-end.z-markdown, .z-text.z-html.z-markdown .z-markup.z-raw.z-code-fence.z-markdown .z-constant.z-other.z-language-name.z-markdown {

     

       290
       +
        color: #8fbcbb;

     

       291
       +
       }

     

       292
       +
       .z-text.z-html.z-markdown .z-punctuation.z-definition.z-list_item.z-markdown, .z-text.z-html.z-markdown .z-markup.z-list.z-numbered.z-bullet.z-markdown {

     

       293
       +
        color: #81a1c1;

     

       294
       +
       }

     

       295
       +
       .z-text.z-html.z-markdown .z-markup.z-quote.z-markdown .z-punctuation.z-definition.z-blockquote.z-markdown {

     

       296
       +
        color: #8fbcbb;

     

       297
       +
       }

     

       298
       +
       .z-text.z-html.z-markdown .z-meta.z-link.z-inline.z-description.z-markdown, .z-text.z-html.z-markdown .z-meta.z-image.z-inline.z-description.z-markdown, .z-text.z-html.z-markdown .z-meta.z-link.z-reference.z-description.z-markdown, .z-text.z-html.z-markdown .z-constant.z-other.z-reference.z-link.z-markdown, .z-text.z-html.z-markdown .z-entity.z-name.z-reference.z-link.z-markdown {

     

       299
       +
        color: #88c0d0;

     

       300
       +
       }

     

       301
       +
       .z-text.z-html.z-markdown .z-punctuation.z-definition.z-link.z-begin.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-definition.z-link.z-end.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-definition.z-image.z-begin.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-definition.z-image.z-end.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-definition.z-constant.z-begin.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-definition.z-constant.z-end.z-markdown {

     

       302
       +
        color: #81a1c1;

     

       303
       +
       }

     

       304
       +
       .z-text.z-html.z-markdown .z-punctuation.z-separator.z-table-cell.z-markdown, .z-text.z-html.z-markdown .z-punctuation.z-section.z-table-header.z-markdown {

     

       305
       +
        color: #81a1c1;

     

       306
       +
       }

     

       307
       +
       .z-text.z-html.z-markdown .z-meta.z-table.z-header.z-markdown {

     

       308
       +
        color: #88c0d0;

     

       309
       +
       }

     

       310
       +
       .z-text.z-html.z-markdown .z-punctuation.z-definition.z-thematic-break.z-markdown {

     

       311
       +
        color: #81a1c1;

     

       312
       +
       font-weight: bold;

     

       313
       +
       }

     

       314
       +
       .z-embedding.z-php .z-text.z-html.z-basic .z-punctuation.z-section.z-embedded.z-begin.z-php, .z-embedding.z-php .z-text.z-html.z-basic .z-punctuation.z-section.z-embedded.z-end.z-php {

     

       315
       +
        color: #5e81ac;

     

       316
       +
       }

     

       317
       +
       .z-embedding.z-php .z-text.z-html.z-basic .z-comment.z-block.z-documentation.z-phpdoc.z-php .z-keyword.z-other.z-phpdoc.z-php {

     

       318
       +
        color: #8fbcbb;

     

       319
       +
       }

     

       320
       +
       .z-embedding.z-php .z-text.z-html.z-basic .z-support.z-other.z-namespace.z-php {

     

       321
       +
        color: #8fbcbb;

     

       322
       +
       }

     

       323
       +
       .z-source.z-python .z-meta.z-annotation.z-python .z-meta.z-qualified-name.z-python .z-support.z-function.z-builtin.z-python, .z-source.z-python .z-punctuation.z-definition.z-annotation.z-python {

     

       324
       +
        color: #d08770;

     

       325
       +
       }

     

       326
       +
       .z-support.z-function.z-builtin.z-python {

     

       327
       +
       font-style: italic;

     

       328
       +
       }

     

       329
       +
       .z-source.z-python .z-support.z-type.z-exception.z-python {

     

       330
       +
        color: #8fbcbb;

     

       331
       +
       }

     

       332
       +
       .z-source.z-python .z-support.z-type.z-python {

     

       333
       +
        color: #81a1c1;

     

       334
       +
       }

     

       335
       +
       .z-source.z-sass .z-variable.z-parameter.z-sass {

     

       336
       +
        color: #d8dee9;

     

       337
       +
       font-weight: bold;

     

       338
       +
       }

     

       339
       +
       .z-source.z-ruby .z-support.z-function.z-builtin.z-ruby {

     

       340
       +
       font-style: italic;

     

       341
       +
       }

     

       342
       +
       .z-source.z-shell .z-support.z-function.z-builtin.z-shell {

     

       343
       +
       font-style: italic;

     

       344
       +
       }

     

       345
       +
       .z-text.z-xml .z-entity.z-name.z-tag.z-namespace {

     

       346
       +
        color: #8fbcbb;

     

       347
       +
       }

     

       348
       +
       .z-text.z-xml .z-meta.z-tag.z-sgml.z-doctype.z-xml, .z-text.z-xml .z-meta.z-tag.z-preprocessor .z-entity.z-name.z-tag, .z-text.z-xml .z-meta.z-tag.z-preprocessor.z-xml .z-punctuation.z-definition.z-tag.z-begin.z-xml, .z-text.z-xml .z-meta.z-tag.z-preprocessor.z-xml .z-punctuation.z-definition.z-tag.z-end.z-xml, .z-text.z-xml .z-meta.z-tag.z-sgml.z-doctype.z-xml .z-punctuation.z-definition.z-tag.z-begin.z-xml, .z-text.z-xml .z-meta.z-tag.z-sgml.z-doctype.z-xml .z-punctuation.z-definition.z-tag.z-end.z-xml {

     

       349
       +
        color: #5e81ac;

     

       350
       +
       }

     

       351
       +
       .z-text.z-xml .z-string.z-unquoted.z-cdata.z-xml .z-punctuation.z-definition.z-string.z-begin.z-xml, .z-text.z-xml .z-string.z-unquoted.z-cdata.z-xml .z-punctuation.z-definition.z-string.z-end.z-xml {

     

       352
       +
        color: #d08770;

     

       353
       +
       font-style: italic;

     

       354
       +
       }

     

       355
       +
       .z-source.z-yaml .z-entity.z-name.z-tag {

     

       356
       +
        color: #8fbcbb;

     

       357
       +
       }

     

       358
       +
       .z-sublimelinter.z-mark.z-warning {

     

       359
       +
        color: #ebcb8b;

     

       360
       +
       }

     

       361
       +
       .z-sublimelinter.z-mark.z-error {

     

       362
       +
        color: #bf616a;

     

       363
       +
       }

     

       364
       +
       .z-markup.z-ignored.z-git_gutter {

     

       365
       +
        color: #616e88;

     

       366
       +
       }

     

       367
       +
       .z-markup.z-untracked.z-git_gutter {

     

       368
       +
        color: #88c0d0;

     

       369
       +
       }

     

       370
       +
       .z-markup.z-inserted.z-git_gutter {

     

       371
       +
        color: #a3be8c;

     

       372
       +
       }

     

       373
       +
       .z-markup.z-changed.z-git_gutter {

     

       374
       +
        color: #ebcb8b;

     

       375
       +
       }

     

       376
       +
       .z-markup.z-deleted.z-git_gutter {

     

       377
       +
        color: #bf616a;

     

       378
       +
       }

     

       379
       +
       .z-source.z-js .z-tag.z-decorator.z-js .z-entity.z-name.z-tag.z-js, .z-source.z-js .z-tag.z-decorator.z-js .z-punctuation.z-definition.z-tag.z-js {

     

       380
       +
        color: #d08770;

     

       381
       +
       }

     

       382
       +
       .z-source.z-js .z-string.z-quoted.z-js, .z-source.z-js .z-string.z-quoted.z-jsx, .z-source.z-js .z-meta.z-class.z-js .z-meta.z-class.z-property.z-js .z-string.z-interpolated.z-js, .z-source.z-js .z-string.z-interpolated.z-js, .z-source.z-js .z-string.z-template.z-js {

     

       383
       +
        color: #a3be8c;

     

       384
       +
       }

     

       385
       +
       .z-source.z-js .z-variable.z-other.z-constant.z-js {

     

       386
       +
        color: #d8dee9;

     

       387
       +
       font-weight: bold;

     

       388
       +
       }

     

       389
       +
       .z-source.z-js .z-constant.z-other.z-object.z-key.z-js .z-string.z-unquoted.z-label.z-js, .z-source.z-js .z-variable.z-other.z-readwrite.z-js {

     

       390
       +
        color: #d8dee9;

     

       391
       +
       }

     

       392
       +
       .z-source.z-js .z-meta.z-class.z-js .z-meta.z-class.z-property.z-js .z-variable.z-other.z-property.z-js {

     

       393
       +
        color: #88c0d0;

     

       394
       +
       }

     

       395
       +
       .z-source.z-js .z-variable.z-other.z-property.z-static.z-js {

     

       396
       +
       font-style: italic;

     

       397
       +
       }

     

       398
       +
       .z-source.z-js .z-variable.z-other.z-class.z-js {

     

       399
       +
        color: #8fbcbb;

     

       400
       +
       }

     

       401
       +
       .z-source.z-js .z-string.z-interpolated.z-js .z-keyword.z-other.z-substitution.z-begin.z-js, .z-source.z-js .z-string.z-interpolated.z-js .z-keyword.z-other.z-substitution.z-end.z-js, .z-source.z-js .z-punctuation.z-definition.z-template-expression.z-begin.z-js, .z-source.z-js .z-punctuation.z-definition.z-template-expression.z-end.z-js {

     

       402
       +
        color: #5e81ac;

     

       403
       +
       }

     

       404
       +
       .z-source.z-js .z-keyword.z-operator.z-spread.z-js {

     

       405
       +
        color: #81a1c1;

     

       406
       +
       }

     

       407
       +
       .z-source.z-js .z-meta.z-export.z-js .z-variable.z-other.z-readwrite.z-js {

     

       408
       +
        color: #8fbcbb;

     

       409
       +
       }

     

       410
       +
       .z-source.z-ts .z-meta.z-class.z-ts .z-entity.z-other.z-inherited-class.z-ts {

     

       411
       +
        color: #8fbcbb;

     

       412
       +
       font-weight: bold;

     

       413
       +
       }

     

       414
       +
       .z-source.z-ts .z-entity.z-name.z-type.z-class.z-ts, .z-source.z-ts .z-entity.z-name.z-type.z-enum.z-ts {

     

       415
       +
        color: #8fbcbb;

     

       416
       +
       }

     

       417
       +
       .z-source.z-ts .z-entity.z-name.z-type.z-ts {

     

       418
       +
        color: #8fbcbb;

     

       419
       +
       }

     

       420
       +
       .z-source.z-ts .z-support.z-type.z-primitive.z-ts {

     

       421
       +
        color: #81a1c1;

     

       422
       +
       }

     

       423
       +
       .z-source.z-ts .z-meta.z-class.z-ts .z-meta.z-method.z-declaration.z-ts .z-meta.z-parameters.z-ts .z-meta.z-decorator.z-ts .z-variable.z-other.z-readwrite.z-ts, .z-source.z-ts .z-meta.z-class.z-ts .z-meta.z-method.z-declaration.z-ts .z-meta.z-parameters.z-ts .z-meta.z-decorator.z-ts .z-punctuation.z-decorator.z-ts {

     

       424
       +
        color: #d08770;

     

       425
       +
       }

     

       426
       +
       .z-source.z-ts .z-punctuation.z-definition.z-template-expression.z-begin.z-ts, .z-source.z-ts .z-punctuation.z-definition.z-template-expression.z-end.z-ts {

     

       427
       +
        color: #5e81ac;

     

       428
       +
       }

     

       429
       +
       .z-source.z-ts .z-string.z-template.z-ts {

     

       430
       +
        color: #a3be8c;

     

       431
       +
       }

     

       432
       +
       .z-source.z-ts .z-support.z-function.z-math.z-ts {

     

       433
       +
       font-style: italic;

     

       434
       +
       }

     

       435
       +
       .z-source.z-ts .z-variable.z-other.z-constant.z-property.z-ts, .z-source.z-ts .z-variable.z-other.z-enummember.z-ts, .z-source.z-ts .z-variable.z-other.z-constant.z-ts {

     

       436
       +
        color: #d8dee9;

     

       437
       +
       font-weight: bold;

     

       438
       +
       }

     

       439
       +
       .z-source.z-ts .z-comment.z-block.z-documentation.z-ts .z-storage.z-type.z-class.z-jsdoc {

     

       440
       +
        color: #8fbcbb;

     

       441
       +
       }

statichost.yml

···

       1
       +
       image: ghcr.io/getzola/zola:v0.21.0

     

       2
       +
       command: build

     

       3
       +
       public: public

     

       4
       +
       image_entrypoint: true

     

       5
       +
       

     

       6
       +
       # TODO: Usa nix there

     

       7
       +
       # image: ghcr.io/lix-project/lix:latest

     

       8
       +
       # command: nix --extra-experimental-features nix-command --extra-experimental-features flakes run .#publish

     

       9
       +
       # public: public

styles/markdown.rb

···

       1
       +
       all

     

       2
       +
       exclude_rule 'MD002'

     

       3
       +
       exclude_rule 'MD041'

     

       4
       +
       

     

       5
       +
       rule 'MD013', ignore_code_blocks: true

styles/proselint/Airlinese.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is airlinese."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - enplan(?:e|ed|ing|ement)

     

       7
       +
         - deplan(?:e|ed|ing|ement)

     

       8
       +
         - taking off momentarily

+48

styles/proselint/AnimalLabels.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: "Consider using '%s' instead of '%s'."

     

       3
       +
       level: error

     

       4
       +
       action:

     

       5
       +
         name: replace

     

       6
       +
       swap:

     

       7
       +
         (?:bull|ox)-like:  taurine

     

       8
       +
         (?:calf|veal)-like: vituline

     

       9
       +
         (?:crow|raven)-like: corvine

     

       10
       +
         (?:leopard|panther)-like: pardine

     

       11
       +
         bird-like:  avine

     

       12
       +
         centipede-like:  scolopendrine

     

       13
       +
         crab-like:  cancrine

     

       14
       +
         crocodile-like:  crocodiline

     

       15
       +
         deer-like:  damine

     

       16
       +
         eagle-like:  aquiline

     

       17
       +
         earthworm-like:  lumbricine

     

       18
       +
         falcon-like:  falconine

     

       19
       +
         ferine:  wild animal-like

     

       20
       +
         fish-like:  piscine

     

       21
       +
         fox-like:  vulpine

     

       22
       +
         frog-like:  ranine

     

       23
       +
         goat-like:  hircine

     

       24
       +
         goose-like:  anserine

     

       25
       +
         gull-like:  laridine

     

       26
       +
         hare-like:  leporine

     

       27
       +
         hawk-like:  accipitrine

     

       28
       +
         hippopotamus-like:  hippopotamine

     

       29
       +
         lizard-like:  lacertine

     

       30
       +
         mongoose-like:  viverrine

     

       31
       +
         mouse-like:  murine

     

       32
       +
         ostrich-like:  struthionine

     

       33
       +
         peacock-like:  pavonine

     

       34
       +
         porcupine-like:  hystricine

     

       35
       +
         rattlesnake-like:  crotaline

     

       36
       +
         sable-like:  zibeline

     

       37
       +
         sheep-like:  ovine

     

       38
       +
         shrew-like:  soricine

     

       39
       +
         sparrow-like:  passerine

     

       40
       +
         swallow-like:  hirundine

     

       41
       +
         swine-like:  suilline

     

       42
       +
         tiger-like:  tigrine

     

       43
       +
         viper-like:  viperine

     

       44
       +
         vulture-like:  vulturine

     

       45
       +
         wasp-like:  vespine

     

       46
       +
         wolf-like:  lupine

     

       47
       +
         woodpecker-like:  picine

     

       48
       +
         zebra-like:  zebrine

styles/proselint/Annotations.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' left in text."

     

       3
       +
       ignorecase: false

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - XXX

     

       7
       +
         - FIXME

     

       8
       +
         - TODO

     

       9
       +
         - NOTE

styles/proselint/Apologizing.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Excessive apologizing: '%s'"

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       action:

     

       6
       +
         name: remove

     

       7
       +
       tokens:

     

       8
       +
         - More research is needed

+52

styles/proselint/Archaisms.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is archaic."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - alack

     

       7
       +
         - anent

     

       8
       +
         - begat

     

       9
       +
         - belike

     

       10
       +
         - betimes

     

       11
       +
         - boughten

     

       12
       +
         - brocage

     

       13
       +
         - brokage

     

       14
       +
         - camarade

     

       15
       +
         - chiefer

     

       16
       +
         - chiefest

     

       17
       +
         - Christiana

     

       18
       +
         - completely obsolescent

     

       19
       +
         - cozen

     

       20
       +
         - divers

     

       21
       +
         - deflexion

     

       22
       +
         - fain

     

       23
       +
         - forsooth

     

       24
       +
         - foreclose from

     

       25
       +
         - haply

     

       26
       +
         - howbeit

     

       27
       +
         - illumine

     

       28
       +
         - in sooth

     

       29
       +
         - maugre

     

       30
       +
         - meseems

     

       31
       +
         - methinks

     

       32
       +
         - nigh

     

       33
       +
         - peradventure

     

       34
       +
         - perchance

     

       35
       +
         - saith

     

       36
       +
         - shew

     

       37
       +
         - sistren

     

       38
       +
         - spake

     

       39
       +
         - to wit

     

       40
       +
         - verily

     

       41
       +
         - whilom

     

       42
       +
         - withal

     

       43
       +
         - wot

     

       44
       +
         - enclosed please find

     

       45
       +
         - please find enclosed

     

       46
       +
         - enclosed herewith

     

       47
       +
         - enclosed herein

     

       48
       +
         - inforce

     

       49
       +
         - ex postfacto

     

       50
       +
         - foreclose from

     

       51
       +
         - forewent

     

       52
       +
         - for ever

styles/proselint/But.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Do not start a paragraph with a 'but'."

     

       3
       +
       level: error

     

       4
       +
       scope: paragraph

     

       5
       +
       action:

     

       6
       +
         name: remove

     

       7
       +
       tokens:

     

       8
       +
         - ^But

+782

styles/proselint/Cliches.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is a cliche."

     

       3
       +
       level: error

     

       4
       +
       ignorecase: true

     

       5
       +
       tokens:

     

       6
       +
         - a chip off the old block

     

       7
       +
         - a clean slate

     

       8
       +
         - a dark and stormy night

     

       9
       +
         - a far cry

     

       10
       +
         - a fate worse than death

     

       11
       +
         - a fine kettle of fish

     

       12
       +
         - a loose cannon

     

       13
       +
         - a penny saved is a penny earned

     

       14
       +
         - a tough row to hoe

     

       15
       +
         - a word to the wise

     

       16
       +
         - ace in the hole

     

       17
       +
         - acid test

     

       18
       +
         - add insult to injury

     

       19
       +
         - against all odds

     

       20
       +
         - air your dirty laundry

     

       21
       +
         - alas and alack

     

       22
       +
         - all fun and games

     

       23
       +
         - all hell broke loose

     

       24
       +
         - all in a day's work

     

       25
       +
         - all talk, no action

     

       26
       +
         - all thumbs

     

       27
       +
         - all your eggs in one basket

     

       28
       +
         - all's fair in love and war

     

       29
       +
         - all's well that ends well

     

       30
       +
         - almighty dollar

     

       31
       +
         - American as apple pie

     

       32
       +
         - an axe to grind

     

       33
       +
         - another day, another dollar

     

       34
       +
         - armed to the teeth

     

       35
       +
         - as luck would have it

     

       36
       +
         - as old as time

     

       37
       +
         - as the crow flies

     

       38
       +
         - at loose ends

     

       39
       +
         - at my wits end

     

       40
       +
         - at the end of the day

     

       41
       +
         - avoid like the plague

     

       42
       +
         - babe in the woods

     

       43
       +
         - back against the wall

     

       44
       +
         - back in the saddle

     

       45
       +
         - back to square one

     

       46
       +
         - back to the drawing board

     

       47
       +
         - bad to the bone

     

       48
       +
         - badge of honor

     

       49
       +
         - bald faced liar

     

       50
       +
         - bald-faced lie

     

       51
       +
         - ballpark figure

     

       52
       +
         - banging your head against a brick wall

     

       53
       +
         - baptism by fire

     

       54
       +
         - barking up the wrong tree

     

       55
       +
         - bat out of hell

     

       56
       +
         - be all and end all

     

       57
       +
         - beat a dead horse

     

       58
       +
         - beat around the bush

     

       59
       +
         - been there, done that

     

       60
       +
         - beggars can't be choosers

     

       61
       +
         - behind the eight ball

     

       62
       +
         - bend over backwards

     

       63
       +
         - benefit of the doubt

     

       64
       +
         - bent out of shape

     

       65
       +
         - best thing since sliced bread

     

       66
       +
         - bet your bottom dollar

     

       67
       +
         - better half

     

       68
       +
         - better late than never

     

       69
       +
         - better mousetrap

     

       70
       +
         - better safe than sorry

     

       71
       +
         - between a rock and a hard place

     

       72
       +
         - between a rock and a hard place

     

       73
       +
         - between Scylla and Charybdis

     

       74
       +
         - between the devil and the deep blue see

     

       75
       +
         - betwixt and between

     

       76
       +
         - beyond the pale

     

       77
       +
         - bide your time

     

       78
       +
         - big as life

     

       79
       +
         - big cheese

     

       80
       +
         - big fish in a small pond

     

       81
       +
         - big man on campus

     

       82
       +
         - bigger they are the harder they fall

     

       83
       +
         - bird in the hand

     

       84
       +
         - bird's eye view

     

       85
       +
         - birds and the bees

     

       86
       +
         - birds of a feather flock together

     

       87
       +
         - bit the hand that feeds you

     

       88
       +
         - bite the bullet

     

       89
       +
         - bite the dust

     

       90
       +
         - bitten off more than he can chew

     

       91
       +
         - black as coal

     

       92
       +
         - black as pitch

     

       93
       +
         - black as the ace of spades

     

       94
       +
         - blast from the past

     

       95
       +
         - bleeding heart

     

       96
       +
         - blessing in disguise

     

       97
       +
         - blind ambition

     

       98
       +
         - blind as a bat

     

       99
       +
         - blind leading the blind

     

       100
       +
         - blissful ignorance

     

       101
       +
         - blood is thicker than water

     

       102
       +
         - blood sweat and tears

     

       103
       +
         - blow a fuse

     

       104
       +
         - blow off steam

     

       105
       +
         - blow your own horn

     

       106
       +
         - blushing bride

     

       107
       +
         - boils down to

     

       108
       +
         - bolt from the blue

     

       109
       +
         - bone to pick

     

       110
       +
         - bored stiff

     

       111
       +
         - bored to tears

     

       112
       +
         - bottomless pit

     

       113
       +
         - boys will be boys

     

       114
       +
         - bright and early

     

       115
       +
         - brings home the bacon

     

       116
       +
         - broad across the beam

     

       117
       +
         - broken record

     

       118
       +
         - brought back to reality

     

       119
       +
         - bulk large

     

       120
       +
         - bull by the horns

     

       121
       +
         - bull in a china shop

     

       122
       +
         - burn the midnight oil

     

       123
       +
         - burning question

     

       124
       +
         - burning the candle at both ends

     

       125
       +
         - burst your bubble

     

       126
       +
         - bury the hatchet

     

       127
       +
         - busy as a bee

     

       128
       +
         - but that's another story

     

       129
       +
         - by hook or by crook

     

       130
       +
         - call a spade a spade

     

       131
       +
         - called onto the carpet

     

       132
       +
         - calm before the storm

     

       133
       +
         - can of worms

     

       134
       +
         - can't cut the mustard

     

       135
       +
         - can't hold a candle to

     

       136
       +
         - case of mistaken identity

     

       137
       +
         - cast aspersions

     

       138
       +
         - cat got your tongue

     

       139
       +
         - cat's meow

     

       140
       +
         - caught in the crossfire

     

       141
       +
         - caught red-handed

     

       142
       +
         - chase a red herring

     

       143
       +
         - checkered past

     

       144
       +
         - chomping at the bit

     

       145
       +
         - cleanliness is next to godliness

     

       146
       +
         - clear as a bell

     

       147
       +
         - clear as mud

     

       148
       +
         - close to the vest

     

       149
       +
         - cock and bull story

     

       150
       +
         - cold shoulder

     

       151
       +
         - come hell or high water

     

       152
       +
         - comparing apples and oranges

     

       153
       +
         - compleat

     

       154
       +
         - conspicuous by its absence

     

       155
       +
         - cool as a cucumber

     

       156
       +
         - cool, calm, and collected

     

       157
       +
         - cost a king's ransom

     

       158
       +
         - count your blessings

     

       159
       +
         - crack of dawn

     

       160
       +
         - crash course

     

       161
       +
         - creature comforts

     

       162
       +
         - cross that bridge when you come to it

     

       163
       +
         - crushing blow

     

       164
       +
         - cry like a baby

     

       165
       +
         - cry me a river

     

       166
       +
         - cry over spilt milk

     

       167
       +
         - crystal clear

     

       168
       +
         - crystal clear

     

       169
       +
         - curiosity killed the cat

     

       170
       +
         - cut and dried

     

       171
       +
         - cut through the red tape

     

       172
       +
         - cut to the chase

     

       173
       +
         - cute as a bugs ear

     

       174
       +
         - cute as a button

     

       175
       +
         - cute as a puppy

     

       176
       +
         - cuts to the quick

     

       177
       +
         - cutting edge

     

       178
       +
         - dark before the dawn

     

       179
       +
         - day in, day out

     

       180
       +
         - dead as a doornail

     

       181
       +
         - decision-making process

     

       182
       +
         - devil is in the details

     

       183
       +
         - dime a dozen

     

       184
       +
         - divide and conquer

     

       185
       +
         - dog and pony show

     

       186
       +
         - dog days

     

       187
       +
         - dog eat dog

     

       188
       +
         - dog tired

     

       189
       +
         - don't burn your bridges

     

       190
       +
         - don't count your chickens

     

       191
       +
         - don't look a gift horse in the mouth

     

       192
       +
         - don't rock the boat

     

       193
       +
         - don't step on anyone's toes

     

       194
       +
         - don't take any wooden nickels

     

       195
       +
         - down and out

     

       196
       +
         - down at the heels

     

       197
       +
         - down in the dumps

     

       198
       +
         - down the hatch

     

       199
       +
         - down to earth

     

       200
       +
         - draw the line

     

       201
       +
         - dressed to kill

     

       202
       +
         - dressed to the nines

     

       203
       +
         - drives me up the wall

     

       204
       +
         - dubious distinction

     

       205
       +
         - dull as dishwater

     

       206
       +
         - duly authorized

     

       207
       +
         - dyed in the wool

     

       208
       +
         - eagle eye

     

       209
       +
         - ear to the ground

     

       210
       +
         - early bird catches the worm

     

       211
       +
         - easier said than done

     

       212
       +
         - easy as pie

     

       213
       +
         - eat your heart out

     

       214
       +
         - eat your words

     

       215
       +
         - eleventh hour

     

       216
       +
         - even the playing field

     

       217
       +
         - every dog has its day

     

       218
       +
         - every fiber of my being

     

       219
       +
         - everything but the kitchen sink

     

       220
       +
         - eye for an eye

     

       221
       +
         - eyes peeled

     

       222
       +
         - face the music

     

       223
       +
         - facts of life

     

       224
       +
         - fair weather friend

     

       225
       +
         - fall by the wayside

     

       226
       +
         - fan the flames

     

       227
       +
         - far be it from me

     

       228
       +
         - fast and loose

     

       229
       +
         - feast or famine

     

       230
       +
         - feather your nest

     

       231
       +
         - feathered friends

     

       232
       +
         - few and far between

     

       233
       +
         - fifteen minutes of fame

     

       234
       +
         - fills the bill

     

       235
       +
         - filthy vermin

     

       236
       +
         - fine kettle of fish

     

       237
       +
         - first and foremost

     

       238
       +
         - fish out of water

     

       239
       +
         - fishing for a compliment

     

       240
       +
         - fit as a fiddle

     

       241
       +
         - fit the bill

     

       242
       +
         - fit to be tied

     

       243
       +
         - flash in the pan

     

       244
       +
         - flat as a pancake

     

       245
       +
         - flip your lid

     

       246
       +
         - flog a dead horse

     

       247
       +
         - fly by night

     

       248
       +
         - fly the coop

     

       249
       +
         - follow your heart

     

       250
       +
         - for all intents and purposes

     

       251
       +
         - for free

     

       252
       +
         - for the birds

     

       253
       +
         - for what it's worth

     

       254
       +
         - force of nature

     

       255
       +
         - force to be reckoned with

     

       256
       +
         - forgive and forget

     

       257
       +
         - fox in the henhouse

     

       258
       +
         - free and easy

     

       259
       +
         - free as a bird

     

       260
       +
         - fresh as a daisy

     

       261
       +
         - full steam ahead

     

       262
       +
         - fun in the sun

     

       263
       +
         - garbage in, garbage out

     

       264
       +
         - gentle as a lamb

     

       265
       +
         - get a kick out of

     

       266
       +
         - get a leg up

     

       267
       +
         - get down and dirty

     

       268
       +
         - get the lead out

     

       269
       +
         - get to the bottom of

     

       270
       +
         - get with the program

     

       271
       +
         - get your feet wet

     

       272
       +
         - gets my goat

     

       273
       +
         - gilding the lily

     

       274
       +
         - gilding the lily

     

       275
       +
         - give and take

     

       276
       +
         - go against the grain

     

       277
       +
         - go at it tooth and nail

     

       278
       +
         - go for broke

     

       279
       +
         - go him one better

     

       280
       +
         - go the extra mile

     

       281
       +
         - go with the flow

     

       282
       +
         - goes without saying

     

       283
       +
         - good as gold

     

       284
       +
         - good deed for the day

     

       285
       +
         - good things come to those who wait

     

       286
       +
         - good time was had by all

     

       287
       +
         - good times were had by all

     

       288
       +
         - greased lightning

     

       289
       +
         - greek to me

     

       290
       +
         - green thumb

     

       291
       +
         - green-eyed monster

     

       292
       +
         - grist for the mill

     

       293
       +
         - growing like a weed

     

       294
       +
         - hair of the dog

     

       295
       +
         - hand to mouth

     

       296
       +
         - happy as a clam

     

       297
       +
         - happy as a lark

     

       298
       +
         - hasn't a clue

     

       299
       +
         - have a nice day

     

       300
       +
         - have a short fuse

     

       301
       +
         - have high hopes

     

       302
       +
         - have the last laugh

     

       303
       +
         - haven't got a row to hoe

     

       304
       +
         - he's got his hands full

     

       305
       +
         - head honcho

     

       306
       +
         - head over heels

     

       307
       +
         - hear a pin drop

     

       308
       +
         - heard it through the grapevine

     

       309
       +
         - heart's content

     

       310
       +
         - heavy as lead

     

       311
       +
         - hem and haw

     

       312
       +
         - high and dry

     

       313
       +
         - high and mighty

     

       314
       +
         - high as a kite

     

       315
       +
         - his own worst enemy

     

       316
       +
         - his work cut out for him

     

       317
       +
         - hit paydirt

     

       318
       +
         - hither and yon

     

       319
       +
         - Hobson's choice

     

       320
       +
         - hold your head up high

     

       321
       +
         - hold your horses

     

       322
       +
         - hold your own

     

       323
       +
         - hold your tongue

     

       324
       +
         - honest as the day is long

     

       325
       +
         - horns of a dilemma

     

       326
       +
         - horns of a dilemma

     

       327
       +
         - horse of a different color

     

       328
       +
         - hot under the collar

     

       329
       +
         - hour of need

     

       330
       +
         - I beg to differ

     

       331
       +
         - icing on the cake

     

       332
       +
         - if the shoe fits

     

       333
       +
         - if the shoe were on the other foot

     

       334
       +
         - if you catch my drift

     

       335
       +
         - in a jam

     

       336
       +
         - in a jiffy

     

       337
       +
         - in a nutshell

     

       338
       +
         - in a pig's eye

     

       339
       +
         - in a pinch

     

       340
       +
         - in a word

     

       341
       +
         - in hot water

     

       342
       +
         - in light of

     

       343
       +
         - in the final analysis

     

       344
       +
         - in the gutter

     

       345
       +
         - in the last analysis

     

       346
       +
         - in the nick of time

     

       347
       +
         - in the thick of it

     

       348
       +
         - in your dreams

     

       349
       +
         - innocent bystander

     

       350
       +
         - it ain't over till the fat lady sings

     

       351
       +
         - it goes without saying

     

       352
       +
         - it takes all kinds

     

       353
       +
         - it takes one to know one

     

       354
       +
         - it's a small world

     

       355
       +
         - it's not what you know, it's who you know

     

       356
       +
         - it's only a matter of time

     

       357
       +
         - ivory tower

     

       358
       +
         - Jack of all trades

     

       359
       +
         - jockey for position

     

       360
       +
         - jog your memory

     

       361
       +
         - joined at the hip

     

       362
       +
         - judge a book by its cover

     

       363
       +
         - jump down your throat

     

       364
       +
         - jump in with both feet

     

       365
       +
         - jump on the bandwagon

     

       366
       +
         - jump the gun

     

       367
       +
         - jump to conclusions

     

       368
       +
         - just a hop, skip, and a jump

     

       369
       +
         - just the ticket

     

       370
       +
         - justice is blind

     

       371
       +
         - keep a stiff upper lip

     

       372
       +
         - keep an eye on

     

       373
       +
         - keep it simple, stupid

     

       374
       +
         - keep the home fires burning

     

       375
       +
         - keep up with the Joneses

     

       376
       +
         - keep your chin up

     

       377
       +
         - keep your fingers crossed

     

       378
       +
         - kick the bucket

     

       379
       +
         - kick up your heels

     

       380
       +
         - kick your feet up

     

       381
       +
         - kid in a candy store

     

       382
       +
         - kill two birds with one stone

     

       383
       +
         - kiss of death

     

       384
       +
         - knock it out of the park

     

       385
       +
         - knock on wood

     

       386
       +
         - knock your socks off

     

       387
       +
         - know him from Adam

     

       388
       +
         - know the ropes

     

       389
       +
         - know the score

     

       390
       +
         - knuckle down

     

       391
       +
         - knuckle sandwich

     

       392
       +
         - knuckle under

     

       393
       +
         - labor of love

     

       394
       +
         - ladder of success

     

       395
       +
         - land on your feet

     

       396
       +
         - lap of luxury

     

       397
       +
         - last but not least

     

       398
       +
         - last but not least

     

       399
       +
         - last hurrah

     

       400
       +
         - last-ditch effort

     

       401
       +
         - law of the jungle

     

       402
       +
         - law of the land

     

       403
       +
         - lay down the law

     

       404
       +
         - leaps and bounds

     

       405
       +
         - let sleeping dogs lie

     

       406
       +
         - let the cat out of the bag

     

       407
       +
         - let the good times roll

     

       408
       +
         - let your hair down

     

       409
       +
         - let's talk turkey

     

       410
       +
         - letter perfect

     

       411
       +
         - lick your wounds

     

       412
       +
         - lies like a rug

     

       413
       +
         - life's a bitch

     

       414
       +
         - life's a grind

     

       415
       +
         - light at the end of the tunnel

     

       416
       +
         - lighter than a feather

     

       417
       +
         - lighter than air

     

       418
       +
         - like clockwork

     

       419
       +
         - like father like son

     

       420
       +
         - like taking candy from a baby

     

       421
       +
         - like there's no tomorrow

     

       422
       +
         - lion's share

     

       423
       +
         - live and learn

     

       424
       +
         - live and let live

     

       425
       +
         - long and short of it

     

       426
       +
         - long lost love

     

       427
       +
         - look before you leap

     

       428
       +
         - look down your nose

     

       429
       +
         - look what the cat dragged in

     

       430
       +
         - looking a gift horse in the mouth

     

       431
       +
         - looks like death warmed over

     

       432
       +
         - loose cannon

     

       433
       +
         - lose your head

     

       434
       +
         - lose your temper

     

       435
       +
         - loud as a horn

     

       436
       +
         - lounge lizard

     

       437
       +
         - loved and lost

     

       438
       +
         - low man on the totem pole

     

       439
       +
         - luck of the draw

     

       440
       +
         - luck of the Irish

     

       441
       +
         - make a mockery of

     

       442
       +
         - make hay while the sun shines

     

       443
       +
         - make money hand over fist

     

       444
       +
         - make my day

     

       445
       +
         - make the best of a bad situation

     

       446
       +
         - make the best of it

     

       447
       +
         - make your blood boil

     

       448
       +
         - male chauvinism

     

       449
       +
         - man of few words

     

       450
       +
         - man's best friend

     

       451
       +
         - mark my words

     

       452
       +
         - meaningful dialogue

     

       453
       +
         - missed the boat on that one

     

       454
       +
         - moment in the sun

     

       455
       +
         - moment of glory

     

       456
       +
         - moment of truth

     

       457
       +
         - moment of truth

     

       458
       +
         - money to burn

     

       459
       +
         - more in sorrow than in anger

     

       460
       +
         - more power to you

     

       461
       +
         - more sinned against than sinning

     

       462
       +
         - more than one way to skin a cat

     

       463
       +
         - movers and shakers

     

       464
       +
         - moving experience

     

       465
       +
         - my better half

     

       466
       +
         - naked as a jaybird

     

       467
       +
         - naked truth

     

       468
       +
         - neat as a pin

     

       469
       +
         - needle in a haystack

     

       470
       +
         - needless to say

     

       471
       +
         - neither here nor there

     

       472
       +
         - never look back

     

       473
       +
         - never say never

     

       474
       +
         - nip and tuck

     

       475
       +
         - nip in the bud

     

       476
       +
         - nip it in the bud

     

       477
       +
         - no guts, no glory

     

       478
       +
         - no love lost

     

       479
       +
         - no pain, no gain

     

       480
       +
         - no skin off my back

     

       481
       +
         - no stone unturned

     

       482
       +
         - no time like the present

     

       483
       +
         - no use crying over spilled milk

     

       484
       +
         - nose to the grindstone

     

       485
       +
         - not a hope in hell

     

       486
       +
         - not a minute's peace

     

       487
       +
         - not in my backyard

     

       488
       +
         - not playing with a full deck

     

       489
       +
         - not the end of the world

     

       490
       +
         - not written in stone

     

       491
       +
         - nothing to sneeze at

     

       492
       +
         - nothing ventured nothing gained

     

       493
       +
         - now we're cooking

     

       494
       +
         - off the top of my head

     

       495
       +
         - off the wagon

     

       496
       +
         - off the wall

     

       497
       +
         - old hat

     

       498
       +
         - olden days

     

       499
       +
         - older and wiser

     

       500
       +
         - older than dirt

     

       501
       +
         - older than Methuselah

     

       502
       +
         - on a roll

     

       503
       +
         - on cloud nine

     

       504
       +
         - on pins and needles

     

       505
       +
         - on the bandwagon

     

       506
       +
         - on the money

     

       507
       +
         - on the nose

     

       508
       +
         - on the rocks

     

       509
       +
         - on the same page

     

       510
       +
         - on the spot

     

       511
       +
         - on the tip of my tongue

     

       512
       +
         - on the wagon

     

       513
       +
         - on thin ice

     

       514
       +
         - once bitten, twice shy

     

       515
       +
         - one bad apple doesn't spoil the bushel

     

       516
       +
         - one born every minute

     

       517
       +
         - one brick short

     

       518
       +
         - one foot in the grave

     

       519
       +
         - one in a million

     

       520
       +
         - one red cent

     

       521
       +
         - only game in town

     

       522
       +
         - open a can of worms

     

       523
       +
         - open and shut case

     

       524
       +
         - open the flood gates

     

       525
       +
         - opportunity doesn't knock twice

     

       526
       +
         - out of pocket

     

       527
       +
         - out of sight, out of mind

     

       528
       +
         - out of the frying pan into the fire

     

       529
       +
         - out of the woods

     

       530
       +
         - out on a limb

     

       531
       +
         - over a barrel

     

       532
       +
         - over the hump

     

       533
       +
         - pain and suffering

     

       534
       +
         - pain in the

     

       535
       +
         - panic button

     

       536
       +
         - par for the course

     

       537
       +
         - part and parcel

     

       538
       +
         - party pooper

     

       539
       +
         - pass the buck

     

       540
       +
         - patience is a virtue

     

       541
       +
         - pay through the nose

     

       542
       +
         - penny pincher

     

       543
       +
         - perfect storm

     

       544
       +
         - pig in a poke

     

       545
       +
         - pile it on

     

       546
       +
         - pillar of the community

     

       547
       +
         - pin your hopes on

     

       548
       +
         - pitter patter of little feet

     

       549
       +
         - plain as day

     

       550
       +
         - plain as the nose on your face

     

       551
       +
         - play by the rules

     

       552
       +
         - play your cards right

     

       553
       +
         - playing the field

     

       554
       +
         - playing with fire

     

       555
       +
         - pleased as punch

     

       556
       +
         - plenty of fish in the sea

     

       557
       +
         - point with pride

     

       558
       +
         - poor as a church mouse

     

       559
       +
         - pot calling the kettle black

     

       560
       +
         - presidential timber

     

       561
       +
         - pretty as a picture

     

       562
       +
         - pull a fast one

     

       563
       +
         - pull your punches

     

       564
       +
         - pulled no punches

     

       565
       +
         - pulling your leg

     

       566
       +
         - pure as the driven snow

     

       567
       +
         - put it in a nutshell

     

       568
       +
         - put one over on you

     

       569
       +
         - put the cart before the horse

     

       570
       +
         - put the pedal to the metal

     

       571
       +
         - put your best foot forward

     

       572
       +
         - put your foot down

     

       573
       +
         - quantum jump

     

       574
       +
         - quantum leap

     

       575
       +
         - quick as a bunny

     

       576
       +
         - quick as a lick

     

       577
       +
         - quick as a wink

     

       578
       +
         - quick as lightning

     

       579
       +
         - quiet as a dormouse

     

       580
       +
         - rags to riches

     

       581
       +
         - raining buckets

     

       582
       +
         - raining cats and dogs

     

       583
       +
         - rank and file

     

       584
       +
         - rat race

     

       585
       +
         - reap what you sow

     

       586
       +
         - red as a beet

     

       587
       +
         - red herring

     

       588
       +
         - redound to one's credit

     

       589
       +
         - redound to the benefit of

     

       590
       +
         - reinvent the wheel

     

       591
       +
         - rich and famous

     

       592
       +
         - rings a bell

     

       593
       +
         - ripe old age

     

       594
       +
         - ripped me off

     

       595
       +
         - rise and shine

     

       596
       +
         - road to hell is paved with good intentions

     

       597
       +
         - rob Peter to pay Paul

     

       598
       +
         - roll over in the grave

     

       599
       +
         - rub the wrong way

     

       600
       +
         - ruled the roost

     

       601
       +
         - running in circles

     

       602
       +
         - sad but true

     

       603
       +
         - sadder but wiser

     

       604
       +
         - salt of the earth

     

       605
       +
         - scared stiff

     

       606
       +
         - scared to death

     

       607
       +
         - sea change

     

       608
       +
         - sealed with a kiss

     

       609
       +
         - second to none

     

       610
       +
         - see eye to eye

     

       611
       +
         - seen the light

     

       612
       +
         - seize the day

     

       613
       +
         - set the record straight

     

       614
       +
         - set the world on fire

     

       615
       +
         - set your teeth on edge

     

       616
       +
         - sharp as a tack

     

       617
       +
         - shirked his duties

     

       618
       +
         - shoot for the moon

     

       619
       +
         - shoot the breeze

     

       620
       +
         - shot in the dark

     

       621
       +
         - shoulder to the wheel

     

       622
       +
         - sick as a dog

     

       623
       +
         - sigh of relief

     

       624
       +
         - signed, sealed, and delivered

     

       625
       +
         - sink or swim

     

       626
       +
         - six of one, half a dozen of another

     

       627
       +
         - six of one, half a dozen of the other

     

       628
       +
         - skating on thin ice

     

       629
       +
         - slept like a log

     

       630
       +
         - slinging mud

     

       631
       +
         - slippery as an eel

     

       632
       +
         - slow as molasses

     

       633
       +
         - smart as a whip

     

       634
       +
         - smooth as a baby's bottom

     

       635
       +
         - sneaking suspicion

     

       636
       +
         - snug as a bug in a rug

     

       637
       +
         - sow wild oats

     

       638
       +
         - spare the rod, spoil the child

     

       639
       +
         - speak of the devil

     

       640
       +
         - spilled the beans

     

       641
       +
         - spinning your wheels

     

       642
       +
         - spitting image of

     

       643
       +
         - spoke with relish

     

       644
       +
         - spread like wildfire

     

       645
       +
         - spring to life

     

       646
       +
         - squeaky wheel gets the grease

     

       647
       +
         - stands out like a sore thumb

     

       648
       +
         - start from scratch

     

       649
       +
         - stick in the mud

     

       650
       +
         - still waters run deep

     

       651
       +
         - stitch in time

     

       652
       +
         - stop and smell the roses

     

       653
       +
         - straight as an arrow

     

       654
       +
         - straw that broke the camel's back

     

       655
       +
         - stretched to the breaking point

     

       656
       +
         - strong as an ox

     

       657
       +
         - stubborn as a mule

     

       658
       +
         - stuff that dreams are made of

     

       659
       +
         - stuffed shirt

     

       660
       +
         - sweating blood

     

       661
       +
         - sweating bullets

     

       662
       +
         - take a load off

     

       663
       +
         - take one for the team

     

       664
       +
         - take the bait

     

       665
       +
         - take the bull by the horns

     

       666
       +
         - take the plunge

     

       667
       +
         - takes one to know one

     

       668
       +
         - takes two to tango

     

       669
       +
         - than you can shake a stick at

     

       670
       +
         - the cream of the crop

     

       671
       +
         - the cream rises to the top

     

       672
       +
         - the more the merrier

     

       673
       +
         - the real deal

     

       674
       +
         - the real McCoy

     

       675
       +
         - the red carpet treatment

     

       676
       +
         - the same old story

     

       677
       +
         - the straw that broke the camel's back

     

       678
       +
         - there is no accounting for taste

     

       679
       +
         - thick as a brick

     

       680
       +
         - thick as thieves

     

       681
       +
         - thick as thieves

     

       682
       +
         - thin as a rail

     

       683
       +
         - think outside of the box

     

       684
       +
         - thinking outside the box

     

       685
       +
         - third time's the charm

     

       686
       +
         - this day and age

     

       687
       +
         - this hurts me worse than it hurts you

     

       688
       +
         - this point in time

     

       689
       +
         - thought leaders?

     

       690
       +
         - three sheets to the wind

     

       691
       +
         - through thick and thin

     

       692
       +
         - throw in the towel

     

       693
       +
         - throw the baby out with the bathwater

     

       694
       +
         - tie one on

     

       695
       +
         - tighter than a drum

     

       696
       +
         - time and time again

     

       697
       +
         - time is of the essence

     

       698
       +
         - tip of the iceberg

     

       699
       +
         - tired but happy

     

       700
       +
         - to coin a phrase

     

       701
       +
         - to each his own

     

       702
       +
         - to make a long story short

     

       703
       +
         - to the best of my knowledge

     

       704
       +
         - toe the line

     

       705
       +
         - tongue in cheek

     

       706
       +
         - too good to be true

     

       707
       +
         - too hot to handle

     

       708
       +
         - too numerous to mention

     

       709
       +
         - touch with a ten foot pole

     

       710
       +
         - tough as nails

     

       711
       +
         - trial and error

     

       712
       +
         - trials and tribulations

     

       713
       +
         - tried and true

     

       714
       +
         - trip down memory lane

     

       715
       +
         - twist of fate

     

       716
       +
         - two cents worth

     

       717
       +
         - two peas in a pod

     

       718
       +
         - ugly as sin

     

       719
       +
         - under the counter

     

       720
       +
         - under the gun

     

       721
       +
         - under the same roof

     

       722
       +
         - under the weather

     

       723
       +
         - until the cows come home

     

       724
       +
         - unvarnished truth

     

       725
       +
         - up the creek

     

       726
       +
         - uphill battle

     

       727
       +
         - upper crust

     

       728
       +
         - upset the applecart

     

       729
       +
         - vain attempt

     

       730
       +
         - vain effort

     

       731
       +
         - vanquish the enemy

     

       732
       +
         - various and sundry

     

       733
       +
         - vested interest

     

       734
       +
         - viable alternative

     

       735
       +
         - waiting for the other shoe to drop

     

       736
       +
         - wakeup call

     

       737
       +
         - warm welcome

     

       738
       +
         - watch your p's and q's

     

       739
       +
         - watch your tongue

     

       740
       +
         - watching the clock

     

       741
       +
         - water under the bridge

     

       742
       +
         - wax eloquent

     

       743
       +
         - wax poetic

     

       744
       +
         - we've got a situation here

     

       745
       +
         - weather the storm

     

       746
       +
         - weed them out

     

       747
       +
         - week of Sundays

     

       748
       +
         - went belly up

     

       749
       +
         - wet behind the ears

     

       750
       +
         - what goes around comes around

     

       751
       +
         - what you see is what you get

     

       752
       +
         - when it rains, it pours

     

       753
       +
         - when push comes to shove

     

       754
       +
         - when the cat's away

     

       755
       +
         - when the going gets tough, the tough get going

     

       756
       +
         - whet (?:the|your) appetite

     

       757
       +
         - white as a sheet

     

       758
       +
         - whole ball of wax

     

       759
       +
         - whole hog

     

       760
       +
         - whole nine yards

     

       761
       +
         - wild goose chase

     

       762
       +
         - will wonders never cease?

     

       763
       +
         - wisdom of the ages

     

       764
       +
         - wise as an owl

     

       765
       +
         - wolf at the door

     

       766
       +
         - wool pulled over our eyes

     

       767
       +
         - words fail me

     

       768
       +
         - work like a dog

     

       769
       +
         - world weary

     

       770
       +
         - worst nightmare

     

       771
       +
         - worth its weight in gold

     

       772
       +
         - writ large

     

       773
       +
         - wrong side of the bed

     

       774
       +
         - yanking your chain

     

       775
       +
         - yappy as a dog

     

       776
       +
         - years young

     

       777
       +
         - you are what you eat

     

       778
       +
         - you can run but you can't hide

     

       779
       +
         - you only live once

     

       780
       +
         - you're the boss

     

       781
       +
         - young and foolish

     

       782
       +
         - young and vibrant

+30

styles/proselint/CorporateSpeak.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is corporate speak."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - at the end of the day

     

       7
       +
         - back to the drawing board

     

       8
       +
         - hit the ground running

     

       9
       +
         - get the ball rolling

     

       10
       +
         - low-hanging fruit

     

       11
       +
         - thrown under the bus

     

       12
       +
         - think outside the box

     

       13
       +
         - let's touch base

     

       14
       +
         - get my manager's blessing

     

       15
       +
         - it's on my radar

     

       16
       +
         - ping me

     

       17
       +
         - i don't have the bandwidth

     

       18
       +
         - no brainer

     

       19
       +
         - par for the course

     

       20
       +
         - bang for your buck

     

       21
       +
         - synergy

     

       22
       +
         - move the goal post

     

       23
       +
         - apples to apples

     

       24
       +
         - win-win

     

       25
       +
         - circle back around

     

       26
       +
         - all hands on deck

     

       27
       +
         - take this offline

     

       28
       +
         - drill-down

     

       29
       +
         - elephant in the room

     

       30
       +
         - on my plate

styles/proselint/Currency.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Incorrect use of symbols in '%s'."

     

       3
       +
       ignorecase: true

     

       4
       +
       raw:

     

       5
       +
         - \$[\d]* ?(?:dollars|usd|us dollars)

+15

styles/proselint/Cursing.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Consider replacing '%s'."

     

       3
       +
       level: error

     

       4
       +
       ignorecase: true

     

       5
       +
       tokens:

     

       6
       +
         - shit

     

       7
       +
         - piss

     

       8
       +
         - fuck

     

       9
       +
         - cunt

     

       10
       +
         - cocksucker

     

       11
       +
         - motherfucker

     

       12
       +
         - tits

     

       13
       +
         - fart

     

       14
       +
         - turd

     

       15
       +
         - twat

styles/proselint/DateCase.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: With lowercase letters, the periods are standard.

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       nonword: true

     

       6
       +
       tokens:

     

       7
       +
         - '\d{1,2} ?[ap]m\b'

styles/proselint/DateMidnight.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Use 'midnight' or 'noon'."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       nonword: true

     

       6
       +
       tokens:

     

       7
       +
         - '12 ?[ap]\.?m\.?'

+10

styles/proselint/DateRedundancy.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'a.m.' is always morning; 'p.m.' is always night."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       nonword: true

     

       6
       +
       tokens:

     

       7
       +
         - '\d{1,2} ?a\.?m\.? in the morning'

     

       8
       +
         - '\d{1,2} ?p\.?m\.? in the evening'

     

       9
       +
         - '\d{1,2} ?p\.?m\.? at night'

     

       10
       +
         - '\d{1,2} ?p\.?m\.? in the afternoon'

styles/proselint/DateSpacing.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "It's standard to put a space before '%s'"

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       nonword: true

     

       6
       +
       tokens:

     

       7
       +
         - '\d{1,2}[ap]\.?m\.?'

+52

styles/proselint/DenizenLabels.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: Did you mean '%s'?

     

       3
       +
       ignorecase: false

     

       4
       +
       action:

     

       5
       +
         name: replace

     

       6
       +
       swap:

     

       7
       +
         (?:Afrikaaner|Afrikander):             Afrikaner

     

       8
       +
         (?:Hong Kongite|Hong Kongian):         Hong Konger

     

       9
       +
         (?:Indianan|Indianian):                Hoosier

     

       10
       +
         (?:Michiganite|Michiganian):           Michigander

     

       11
       +
         (?:New Hampshireite|New Hampshireman): New Hampshirite

     

       12
       +
         (?:Newcastlite|Newcastleite):          Novocastrian

     

       13
       +
         (?:Providencian|Providencer):          Providentian

     

       14
       +
         (?:Trentian|Trentonian):               Tridentine

     

       15
       +
         (?:Warsawer|Warsawian):                Varsovian

     

       16
       +
         (?:Wolverhamptonite|Wolverhamptonian): Wulfrunian

     

       17
       +
         Alabaman:                              Alabamian

     

       18
       +
         Albuquerquian:                         Albuquerquean

     

       19
       +
         Anchoragite:                           Anchorageite

     

       20
       +
         Arizonian:                             Arizonan

     

       21
       +
         Arkansawyer:                           Arkansan

     

       22
       +
         Belarusan:                             Belarusian

     

       23
       +
         Cayman Islander:                       Caymanian

     

       24
       +
         Coloradoan:                            Coloradan

     

       25
       +
         Connecticuter:                         Nutmegger

     

       26
       +
         Fairbanksian:                          Fairbanksan

     

       27
       +
         Fort Worther:                          Fort Worthian

     

       28
       +
         Grenadian:                             Grenadan

     

       29
       +
         Halifaxer:                             Haligonian

     

       30
       +
         Hartlepoolian:                         Hartlepudlian

     

       31
       +
         Illinoisian:                           Illinoisan

     

       32
       +
         Iowegian:                              Iowan

     

       33
       +
         Leedsian:                              Leodenisian

     

       34
       +
         Liverpoolian:                          Liverpudlian

     

       35
       +
         Los Angelean:                          Angeleno

     

       36
       +
         Manchesterian:                         Mancunian

     

       37
       +
         Minneapolisian:                        Minneapolitan

     

       38
       +
         Missouran:                             Missourian

     

       39
       +
         Monacan:                               Monegasque

     

       40
       +
         Neopolitan:                            Neapolitan

     

       41
       +
         New Jerseyite:                         New Jerseyan

     

       42
       +
         New Orleansian:                        New Orleanian

     

       43
       +
         Oklahoma Citian:                       Oklahoma Cityan

     

       44
       +
         Oklahomian:                            Oklahoman

     

       45
       +
         Saudi Arabian:                         Saudi

     

       46
       +
         Seattlite:                             Seattleite

     

       47
       +
         Surinamer:                             Surinamese

     

       48
       +
         Tallahassean:                          Tallahasseean

     

       49
       +
         Tennesseean:                           Tennessean

     

       50
       +
         Trois-Rivièrester:                     Trifluvian

     

       51
       +
         Utahan:                                Utahn

     

       52
       +
         Valladolidian:                         Vallisoletano

+95

styles/proselint/Diacritical.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: Consider using '%s' instead of '%s'.

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       action:

     

       6
       +
         name: replace

     

       7
       +
       swap:

     

       8
       +
         beau ideal: beau idéal

     

       9
       +
         boutonniere: boutonnière

     

       10
       +
         bric-a-brac: bric-à-brac

     

       11
       +
         cafe: café

     

       12
       +
         cause celebre: cause célèbre

     

       13
       +
         chevre: chèvre

     

       14
       +
         cliche: cliché

     

       15
       +
         consomme: consommé

     

       16
       +
         coup de grace: coup de grâce

     

       17
       +
         crudites: crudités

     

       18
       +
         creme brulee: crème brûlée

     

       19
       +
         creme de menthe: crème de menthe

     

       20
       +
         creme fraice: crème fraîche

     

       21
       +
         creme fresh: crème fraîche

     

       22
       +
         crepe: crêpe

     

       23
       +
         debutante: débutante

     

       24
       +
         decor: décor

     

       25
       +
         deja vu: déjà vu

     

       26
       +
         denouement: dénouement

     

       27
       +
         facade: façade

     

       28
       +
         fiance: fiancé

     

       29
       +
         fiancee: fiancée

     

       30
       +
         flambe: flambé

     

       31
       +
         garcon: garçon

     

       32
       +
         lycee: lycée

     

       33
       +
         maitre d: maître d

     

       34
       +
         menage a trois: ménage à trois

     

       35
       +
         negligee: négligée

     

       36
       +
         protege: protégé

     

       37
       +
         protegee: protégée

     

       38
       +
         puree: purée

     

       39
       +
         my resume: my résumé

     

       40
       +
         your resume: your résumé

     

       41
       +
         his resume: his résumé

     

       42
       +
         her resume: her résumé

     

       43
       +
         a resume: a résumé

     

       44
       +
         the resume: the résumé

     

       45
       +
         risque: risqué

     

       46
       +
         roue: roué

     

       47
       +
         soiree: soirée

     

       48
       +
         souffle: soufflé

     

       49
       +
         soupcon: soupçon

     

       50
       +
         touche: touché

     

       51
       +
         tete-a-tete: tête-à-tête

     

       52
       +
         voila: voilà

     

       53
       +
         a la carte: à la carte

     

       54
       +
         a la mode: à la mode

     

       55
       +
         emigre: émigré

     

       56
       +
       

     

       57
       +
         # Spanish loanwords

     

       58
       +
         El Nino: El Niño

     

       59
       +
         jalapeno: jalapeño

     

       60
       +
         La Nina: La Niña

     

       61
       +
         pina colada: piña colada

     

       62
       +
         senor: señor

     

       63
       +
         senora: señora

     

       64
       +
         senorita: señorita

     

       65
       +
       

     

       66
       +
         # Portuguese loanwords

     

       67
       +
         acai: açaí

     

       68
       +
       

     

       69
       +
         # German loanwords

     

       70
       +
         doppelganger: doppelgänger

     

       71
       +
         Fuhrer: Führer

     

       72
       +
         Gewurztraminer: Gewürztraminer

     

       73
       +
         vis-a-vis: vis-à-vis

     

       74
       +
         Ubermensch: Übermensch

     

       75
       +
       

     

       76
       +
         # Swedish loanwords

     

       77
       +
         filmjolk: filmjölk

     

       78
       +
         smorgasbord: smörgåsbord

     

       79
       +
       

     

       80
       +
         # Names, places, and companies

     

       81
       +
         Beyonce: Beyoncé

     

       82
       +
         Bronte: Brontë

     

       83
       +
         Champs-Elysees: Champs-Élysées

     

       84
       +
         Citroen: Citroën

     

       85
       +
         Curacao: Curaçao

     

       86
       +
         Lowenbrau: Löwenbräu

     

       87
       +
         Monegasque: Monégasque

     

       88
       +
         Motley Crue: Mötley Crüe

     

       89
       +
         Nescafe: Nescafé

     

       90
       +
         Queensryche: Queensrÿche

     

       91
       +
         Quebec: Québec

     

       92
       +
         Quebecois: Québécois

     

       93
       +
         Angstrom: Ångström

     

       94
       +
         angstrom: ångström

     

       95
       +
         Skoda: Škoda

+45

styles/proselint/GenderBias.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: Consider using '%s' instead of '%s'.

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       action:

     

       6
       +
         name: replace

     

       7
       +
       swap:

     

       8
       +
         (?:alumnae|alumni):          graduates

     

       9
       +
         (?:alumna|alumnus):          graduate

     

       10
       +
         air(?:m[ae]n|wom[ae]n):      pilot(s)

     

       11
       +
         anchor(?:m[ae]n|wom[ae]n):   anchor(s)

     

       12
       +
         authoress:                   author

     

       13
       +
         camera(?:m[ae]n|wom[ae]n):   camera operator(s)

     

       14
       +
         chair(?:m[ae]n|wom[ae]n):    chair(s)

     

       15
       +
         congress(?:m[ae]n|wom[ae]n): member(s) of congress

     

       16
       +
         door(?:m[ae]|wom[ae]n):      concierge(s)

     

       17
       +
         draft(?:m[ae]n|wom[ae]n):    drafter(s)

     

       18
       +
         fire(?:m[ae]n|wom[ae]n):     firefighter(s)

     

       19
       +
         fisher(?:m[ae]n|wom[ae]n):   fisher(s)

     

       20
       +
         fresh(?:m[ae]n|wom[ae]n):    first-year student(s)

     

       21
       +
         garbage(?:m[ae]n|wom[ae]n):  waste collector(s)

     

       22
       +
         lady lawyer:                 lawyer

     

       23
       +
         ladylike:                    courteous

     

       24
       +
         landlord:                    building manager

     

       25
       +
         mail(?:m[ae]n|wom[ae]n):     mail carriers

     

       26
       +
         man and wife:                husband and wife

     

       27
       +
         man enough:                  strong enough

     

       28
       +
         mankind:                     human kind

     

       29
       +
         manmade:                     manufactured

     

       30
       +
         men and girls:               men and women

     

       31
       +
         middle(?:m[ae]n|wom[ae]n):   intermediary

     

       32
       +
         news(?:m[ae]n|wom[ae]n):     journalist(s)

     

       33
       +
         ombuds(?:man|woman):         ombuds

     

       34
       +
         oneupmanship:                upstaging

     

       35
       +
         poetess:                     poet

     

       36
       +
         police(?:m[ae]n|wom[ae]n):   police officer(s)

     

       37
       +
         repair(?:m[ae]n|wom[ae]n):   technician(s)

     

       38
       +
         sales(?:m[ae]n|wom[ae]n):    salesperson or sales people

     

       39
       +
         service(?:m[ae]n|wom[ae]n):  soldier(s)

     

       40
       +
         steward(?:ess)?:             flight attendant

     

       41
       +
         tribes(?:m[ae]n|wom[ae]n):   tribe member(s)

     

       42
       +
         waitress:                    waiter

     

       43
       +
         woman doctor:                doctor

     

       44
       +
         woman scientist[s]?:         scientist(s)

     

       45
       +
         work(?:m[ae]n|wom[ae]n):     worker(s)

+39

styles/proselint/GroupTerms.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: Consider using '%s' instead of '%s'.

     

       3
       +
       ignorecase: true

     

       4
       +
       action:

     

       5
       +
         name: replace

     

       6
       +
       swap:

     

       7
       +
         (?:bunch|group|pack|flock) of chickens:    brood of chickens

     

       8
       +
         (?:bunch|group|pack|flock) of crows:       murder of crows

     

       9
       +
         (?:bunch|group|pack|flock) of hawks:       cast of hawks

     

       10
       +
         (?:bunch|group|pack|flock) of parrots:     pandemonium of parrots

     

       11
       +
         (?:bunch|group|pack|flock) of peacocks:    muster of peacocks

     

       12
       +
         (?:bunch|group|pack|flock) of penguins:    muster of penguins

     

       13
       +
         (?:bunch|group|pack|flock) of sparrows:    host of sparrows

     

       14
       +
         (?:bunch|group|pack|flock) of turkeys:     rafter of turkeys

     

       15
       +
         (?:bunch|group|pack|flock) of woodpeckers: descent of woodpeckers

     

       16
       +
         (?:bunch|group|pack|herd) of apes:         shrewdness of apes

     

       17
       +
         (?:bunch|group|pack|herd) of baboons:      troop of baboons

     

       18
       +
         (?:bunch|group|pack|herd) of badgers:      cete of badgers

     

       19
       +
         (?:bunch|group|pack|herd) of bears:        sloth of bears

     

       20
       +
         (?:bunch|group|pack|herd) of bullfinches:  bellowing of bullfinches

     

       21
       +
         (?:bunch|group|pack|herd) of bullocks:     drove of bullocks

     

       22
       +
         (?:bunch|group|pack|herd) of caterpillars: army of caterpillars

     

       23
       +
         (?:bunch|group|pack|herd) of cats:         clowder of cats

     

       24
       +
         (?:bunch|group|pack|herd) of colts:        rag of colts

     

       25
       +
         (?:bunch|group|pack|herd) of crocodiles:   bask of crocodiles

     

       26
       +
         (?:bunch|group|pack|herd) of dolphins:     school of dolphins

     

       27
       +
         (?:bunch|group|pack|herd) of foxes:        skulk of foxes

     

       28
       +
         (?:bunch|group|pack|herd) of gorillas:     band of gorillas

     

       29
       +
         (?:bunch|group|pack|herd) of hippopotami:  bloat of hippopotami

     

       30
       +
         (?:bunch|group|pack|herd) of horses:       drove of horses

     

       31
       +
         (?:bunch|group|pack|herd) of jellyfish:    fluther of jellyfish

     

       32
       +
         (?:bunch|group|pack|herd) of kangeroos:    mob of kangeroos

     

       33
       +
         (?:bunch|group|pack|herd) of monkeys:      troop of monkeys

     

       34
       +
         (?:bunch|group|pack|herd) of oxen:         yoke of oxen

     

       35
       +
         (?:bunch|group|pack|herd) of rhinoceros:   crash of rhinoceros

     

       36
       +
         (?:bunch|group|pack|herd) of wild boar:    sounder of wild boar

     

       37
       +
         (?:bunch|group|pack|herd) of wild pigs:    drift of wild pigs

     

       38
       +
         (?:bunch|group|pack|herd) of zebras:       zeal of wild pigs

     

       39
       +
         (?:bunch|group|pack|school) of trout:      hover of trout

styles/proselint/Hedging.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is hedging."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - I would argue that

     

       7
       +
         - ', so to speak'

     

       8
       +
         - to a certain degree

styles/proselint/Hyperbole.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is hyperbolic."

     

       3
       +
       level: error

     

       4
       +
       nonword: true

     

       5
       +
       tokens:

     

       6
       +
         - '[a-z]+[!?]{2,}'

+11

styles/proselint/Jargon.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is jargon."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - in the affirmative

     

       7
       +
         - in the negative

     

       8
       +
         - agendize

     

       9
       +
         - per your order

     

       10
       +
         - per your request

     

       11
       +
         - disincentivize

+13

styles/proselint/LGBTOffensive.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is offensive. Remove it or consider the context."

     

       3
       +
       ignorecase: true

     

       4
       +
       tokens:

     

       5
       +
         - fag

     

       6
       +
         - faggot

     

       7
       +
         - dyke

     

       8
       +
         - sodomite

     

       9
       +
         - homosexual agenda

     

       10
       +
         - gay agenda

     

       11
       +
         - transvestite

     

       12
       +
         - homosexual lifestyle

     

       13
       +
         - gay lifestyle

+15

styles/proselint/LGBTTerms.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: "Consider using '%s' instead of '%s'."

     

       3
       +
       ignorecase: true

     

       4
       +
       action:

     

       5
       +
         name: replace

     

       6
       +
       swap:

     

       7
       +
         homosexual man:                            gay man

     

       8
       +
         homosexual men:                            gay men

     

       9
       +
         homosexual woman:                          lesbian

     

       10
       +
         homosexual women:                          lesbians

     

       11
       +
         homosexual people:                         gay people

     

       12
       +
         homosexual couple:                         gay couple

     

       13
       +
         sexual preference:                         sexual orientation

     

       14
       +
         (?:admitted homosexual|avowed homosexual): openly gay

     

       15
       +
         special rights:                            equal rights

styles/proselint/Malapropisms.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is a malapropism."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - the infinitesimal universe

     

       7
       +
         - a serial experience

     

       8
       +
         - attack my voracity

+358

styles/proselint/Needless.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: Prefer '%s' over '%s'

     

       3
       +
       ignorecase: true

     

       4
       +
       action:

     

       5
       +
         name: replace

     

       6
       +
       swap:

     

       7
       +
         '(?:cell phone|cell-phone)': cellphone

     

       8
       +
         '(?:cliquey|cliquy)': cliquish

     

       9
       +
         '(?:pygmean|pygmaen)': pygmy

     

       10
       +
         '(?:retributional|retributionary)': retributive

     

       11
       +
         '(?:revokable|revokeable)': revocable

     

       12
       +
         abolishment: abolition

     

       13
       +
         accessary: accessory

     

       14
       +
         accreditate: accredit

     

       15
       +
         accruement: accrual

     

       16
       +
         accusee: accused

     

       17
       +
         acquaintanceship: acquaintance

     

       18
       +
         acquitment: acquittal

     

       19
       +
         administrate: administer

     

       20
       +
         administrated: administered

     

       21
       +
         administrating: administering

     

       22
       +
         adulterate: adulterous

     

       23
       +
         advisatory: advisory

     

       24
       +
         advocator: advocate

     

       25
       +
         aggrievance: grievance

     

       26
       +
         allegator: alleger

     

       27
       +
         allusory: allusive

     

       28
       +
         amative: amorous

     

       29
       +
         amortizement: amortization

     

       30
       +
         amphiboly: amphibology

     

       31
       +
         anecdotalist: anecdotist

     

       32
       +
         anilinctus: anilingus

     

       33
       +
         anticipative: anticipatory

     

       34
       +
         antithetic: antithetical

     

       35
       +
         applicative: applicable

     

       36
       +
         applicatory: applicable

     

       37
       +
         applier: applicator

     

       38
       +
         approbative: approbatory

     

       39
       +
         arbitrager: arbitrageur

     

       40
       +
         arsenous: arsenious

     

       41
       +
         ascendance: ascendancy

     

       42
       +
         ascendence: ascendancy

     

       43
       +
         ascendency: ascendancy

     

       44
       +
         auctorial: authorial

     

       45
       +
         averral: averment

     

       46
       +
         barbwire: barbed wire

     

       47
       +
         benefic: beneficent

     

       48
       +
         benignant: benign

     

       49
       +
         bestowment: bestowal

     

       50
       +
         betrothment: betrothal

     

       51
       +
         blamableness: blameworthiness

     

       52
       +
         butt naked: buck naked

     

       53
       +
         camarade: comrade

     

       54
       +
         carta blanca: carte blanche

     

       55
       +
         casualities: casualties

     

       56
       +
         casuality: casualty

     

       57
       +
         catch on fire: catch fire

     

       58
       +
         catholicly: catholically

     

       59
       +
         cease fire: ceasefire

     

       60
       +
         channelize: channel

     

       61
       +
         chaplainship: chaplaincy

     

       62
       +
         chrysalid: chrysalis

     

       63
       +
         chrysalids: chrysalises

     

       64
       +
         cigaret: cigarette

     

       65
       +
         coemployee: coworker

     

       66
       +
         cognitional: cognitive

     

       67
       +
         cohabitate: cohabit

     

       68
       +
         cohabitor: cohabitant

     

       69
       +
         collodium: collodion

     

       70
       +
         collusory: collusive

     

       71
       +
         commemoratory: commemorative

     

       72
       +
         commonty: commonage

     

       73
       +
         communicatory: communicative

     

       74
       +
         compensative: compensatory

     

       75
       +
         complacence: complacency

     

       76
       +
         complicitous: complicit

     

       77
       +
         computate: compute

     

       78
       +
         conciliative: conciliatory

     

       79
       +
         concomitancy: concomitance

     

       80
       +
         condonance: condonation

     

       81
       +
         confirmative: confirmatory

     

       82
       +
         congruency: congruence

     

       83
       +
         connotate: connote

     

       84
       +
         consanguineal: consanguine

     

       85
       +
         conspicuity: conspicuousness

     

       86
       +
         conspiratorialist: conspirator

     

       87
       +
         constitutionist: constitutionalist

     

       88
       +
         contingence: contigency

     

       89
       +
         contributary: contributory

     

       90
       +
         contumacity: contumacy

     

       91
       +
         conversible: convertible

     

       92
       +
         conveyal: conveyance

     

       93
       +
         copartner: partner

     

       94
       +
         copartnership: partnership

     

       95
       +
         corroboratory: corroborative

     

       96
       +
         cotemporaneous: contemporaneous

     

       97
       +
         cotemporary: contemporary

     

       98
       +
         criminate: incriminate

     

       99
       +
         culpatory: inculpatory

     

       100
       +
         cumbrance: encumbrance

     

       101
       +
         cumulate: accumulate

     

       102
       +
         curatory: curative

     

       103
       +
         daredeviltry: daredevilry

     

       104
       +
         deceptious: deceptive

     

       105
       +
         defamative: defamatory

     

       106
       +
         defraudulent: fraudulent

     

       107
       +
         degeneratory: degenerative

     

       108
       +
         delimitate: delimit

     

       109
       +
         delusory: delusive

     

       110
       +
         denouncement: denunciation

     

       111
       +
         depositee: depositary

     

       112
       +
         depreciative: depreciatory

     

       113
       +
         deprival: deprivation

     

       114
       +
         derogative: derogatory

     

       115
       +
         destroyable: destructible

     

       116
       +
         detoxicate: detoxify

     

       117
       +
         detractory: detractive

     

       118
       +
         deviancy: deviance

     

       119
       +
         deviationist: deviant

     

       120
       +
         digamy: deuterogamy

     

       121
       +
         digitalize: digitize

     

       122
       +
         diminishment: diminution

     

       123
       +
         diplomatist: diplomat

     

       124
       +
         disassociate: dissociate

     

       125
       +
         disciplinatory: disciplinary

     

       126
       +
         discriminant: discriminating

     

       127
       +
         disenthrone: dethrone

     

       128
       +
         disintegratory: disintegrative

     

       129
       +
         dismission: dismissal

     

       130
       +
         disorientate: disorient

     

       131
       +
         disorientated: disoriented

     

       132
       +
         disquieten: disquiet

     

       133
       +
         distraite: distrait

     

       134
       +
         divergency: divergence

     

       135
       +
         dividable: divisible

     

       136
       +
         doctrinary: doctrinaire

     

       137
       +
         documental: documentary

     

       138
       +
         domesticize: domesticate

     

       139
       +
         duplicatory: duplicative

     

       140
       +
         duteous: dutiful

     

       141
       +
         educationalist: educationist

     

       142
       +
         educatory: educative

     

       143
       +
         enigmatas: enigmas

     

       144
       +
         enlargen: enlarge

     

       145
       +
         enswathe: swathe

     

       146
       +
         epical: epic

     

       147
       +
         erotism: eroticism

     

       148
       +
         ethician: ethicist

     

       149
       +
         ex officiis: ex officio

     

       150
       +
         exculpative: exculpatory

     

       151
       +
         exigeant: exigent

     

       152
       +
         exigence: exigency

     

       153
       +
         exotism: exoticism

     

       154
       +
         expedience: expediency

     

       155
       +
         expediential: expedient

     

       156
       +
         extensible: extendable

     

       157
       +
         eying: eyeing

     

       158
       +
         fiefdom: fief

     

       159
       +
         flagrance: flagrancy

     

       160
       +
         flatulency: flatulence

     

       161
       +
         fraudful: fraudulent

     

       162
       +
         funebrial: funereal

     

       163
       +
         geographical: geographic

     

       164
       +
         geometrical: geometric

     

       165
       +
         gerry-rigged: jury-rigged

     

       166
       +
         goatherder: goatherd

     

       167
       +
         gustatorial: gustatory

     

       168
       +
         habitude: habit

     

       169
       +
         henceforward: henceforth

     

       170
       +
         hesitance: hesitancy

     

       171
       +
         heterogenous: heterogeneous

     

       172
       +
         hierarchic: hierarchical

     

       173
       +
         hindermost: hindmost

     

       174
       +
         honorand: honoree

     

       175
       +
         hypostasize: hypostatize

     

       176
       +
         hysteric: hysterical

     

       177
       +
         idolatrize: idolize

     

       178
       +
         impanel: empanel

     

       179
       +
         imperviable: impervious

     

       180
       +
         importunacy: importunity

     

       181
       +
         impotency: impotence

     

       182
       +
         imprimatura: imprimatur

     

       183
       +
         improprietous: improper

     

       184
       +
         inalterable: unalterable

     

       185
       +
         incitation: incitement

     

       186
       +
         incommunicative: uncommunicative

     

       187
       +
         inconsistence: inconsistency

     

       188
       +
         incontrollable: uncontrollable

     

       189
       +
         incurment: incurrence

     

       190
       +
         indow: endow

     

       191
       +
         indue: endue

     

       192
       +
         inhibitive: inhibitory

     

       193
       +
         innavigable: unnavigable

     

       194
       +
         innovational: innovative

     

       195
       +
         inquisitional: inquisitorial

     

       196
       +
         insistment: insistence

     

       197
       +
         insolvable: unsolvable

     

       198
       +
         instillment: instillation

     

       199
       +
         instinctual: instinctive

     

       200
       +
         insuror: insurer

     

       201
       +
         insurrectional: insurrectionary

     

       202
       +
         interpretate: interpret

     

       203
       +
         intervenience: intervention

     

       204
       +
         ironical: ironic

     

       205
       +
         jerry-rigged: jury-rigged

     

       206
       +
         judgmatic: judgmental

     

       207
       +
         labyrinthian: labyrinthine

     

       208
       +
         laudative: laudatory

     

       209
       +
         legitimatization: legitimation

     

       210
       +
         legitimatize: legitimize

     

       211
       +
         legitimization: legitimation

     

       212
       +
         lengthways: lengthwise

     

       213
       +
         life-sized: life-size

     

       214
       +
         liquorice: licorice

     

       215
       +
         lithesome: lithe

     

       216
       +
         lollipop: lollypop

     

       217
       +
         loth: loath

     

       218
       +
         lubricous: lubricious

     

       219
       +
         maihem: mayhem

     

       220
       +
         medicinal marijuana: medical marijuana

     

       221
       +
         meliorate: ameliorate

     

       222
       +
         minimalize: minimize

     

       223
       +
         mirk: murk

     

       224
       +
         mirky: murky

     

       225
       +
         misdoubt: doubt

     

       226
       +
         monetarize: monetize

     

       227
       +
         moveable: movable

     

       228
       +
         narcism: narcissism

     

       229
       +
         neglective: neglectful

     

       230
       +
         negligency: negligence

     

       231
       +
         neologizer: neologist

     

       232
       +
         neurologic: neurological

     

       233
       +
         nicknack: knickknack

     

       234
       +
         nictate: nictitate

     

       235
       +
         nonenforceable: unenforceable

     

       236
       +
         normalcy: normality

     

       237
       +
         numbedness: numbness

     

       238
       +
         omittable: omissible

     

       239
       +
         onomatopoetic: onomatopoeic

     

       240
       +
         opinioned: opined

     

       241
       +
         optimum advantage: optimal advantage

     

       242
       +
         orientate: orient

     

       243
       +
         outsized: outsize

     

       244
       +
         oversized: oversize

     

       245
       +
         overthrowal: overthrow

     

       246
       +
         pacificist: pacifist

     

       247
       +
         paederast: pederast

     

       248
       +
         parachronism: anachronism

     

       249
       +
         parti-color: parti-colored

     

       250
       +
         participative: participatory

     

       251
       +
         party-colored: parti-colored

     

       252
       +
         pediatrist: pediatrician

     

       253
       +
         penumbrous: penumbral

     

       254
       +
         perjorative: pejorative

     

       255
       +
         permissory: permissive

     

       256
       +
         permutate: permute

     

       257
       +
         personation: impersonation

     

       258
       +
         pharmaceutic: pharmaceutical

     

       259
       +
         pleuritis: pleurisy

     

       260
       +
         policy holder: policyholder

     

       261
       +
         policyowner: policyholder

     

       262
       +
         politicalize: politicize

     

       263
       +
         precedency: precedence

     

       264
       +
         preceptoral: preceptorial

     

       265
       +
         precipitance: precipitancy

     

       266
       +
         precipitant: precipitate

     

       267
       +
         preclusory: preclusive

     

       268
       +
         precolumbian: pre-Columbian

     

       269
       +
         prefectoral: prefectorial

     

       270
       +
         preponderately: preponderantly

     

       271
       +
         preserval: preservation

     

       272
       +
         preventative: preventive

     

       273
       +
         proconsulship: proconsulate

     

       274
       +
         procreational: procreative

     

       275
       +
         procurance: procurement

     

       276
       +
         propelment: propulsion

     

       277
       +
         propulsory: propulsive

     

       278
       +
         prosecutive: prosecutory

     

       279
       +
         protectory: protective

     

       280
       +
         provocatory: provocative

     

       281
       +
         pruriency: prurience

     

       282
       +
         psychal: psychical

     

       283
       +
         punitory: punitive

     

       284
       +
         quantitate: quantify

     

       285
       +
         questionary: questionnaire

     

       286
       +
         quiescency: quiescence

     

       287
       +
         rabbin: rabbi

     

       288
       +
         reasonability: reasonableness

     

       289
       +
         recidivistic: recidivous

     

       290
       +
         recriminative: recriminatory

     

       291
       +
         recruital: recruitment

     

       292
       +
         recurrency: recurrence

     

       293
       +
         recusance: recusancy

     

       294
       +
         recusation: recusal

     

       295
       +
         recusement: recusal

     

       296
       +
         redemptory: redemptive

     

       297
       +
         referrable: referable

     

       298
       +
         referrible: referable

     

       299
       +
         refutatory: refutative

     

       300
       +
         remitment: remittance

     

       301
       +
         remittal: remission

     

       302
       +
         renouncement: renunciation

     

       303
       +
         renunciable: renounceable

     

       304
       +
         reparatory: reparative

     

       305
       +
         repudiative: repudiatory

     

       306
       +
         requitement: requital

     

       307
       +
         rescindment: rescission

     

       308
       +
         restoral: restoration

     

       309
       +
         reticency: reticence

     

       310
       +
         reviewal: review

     

       311
       +
         revisal: revision

     

       312
       +
         revisional: revisionary

     

       313
       +
         revolute: revolt

     

       314
       +
         saliency: salience

     

       315
       +
         salutiferous: salutary

     

       316
       +
         sensatory: sensory

     

       317
       +
         sessionary: sessional

     

       318
       +
         shareowner: shareholder

     

       319
       +
         sicklily: sickly

     

       320
       +
         signator: signatory

     

       321
       +
         slanderize: slander

     

       322
       +
         societary: societal

     

       323
       +
         sodomist: sodomite

     

       324
       +
         solicitate: solicit

     

       325
       +
         speculatory: speculative

     

       326
       +
         spiritous: spirituous

     

       327
       +
         statutorial: statutory

     

       328
       +
         submergeable: submersible

     

       329
       +
         submittal: submission

     

       330
       +
         subtile: subtle

     

       331
       +
         succuba: succubus

     

       332
       +
         sufficience: sufficiency

     

       333
       +
         suppliant: supplicant

     

       334
       +
         surmisal: surmise

     

       335
       +
         suspendible: suspendable

     

       336
       +
         synthetize: synthesize

     

       337
       +
         systemize: systematize

     

       338
       +
         tactual: tactile

     

       339
       +
         tangental: tangential

     

       340
       +
         tautologous: tautological

     

       341
       +
         tee-shirt: T-shirt

     

       342
       +
         thenceforward: thenceforth

     

       343
       +
         transiency: transience

     

       344
       +
         transposal: transposition

     

       345
       +
         unfrequent: infrequent

     

       346
       +
         unreasonability: unreasonableness

     

       347
       +
         unrevokable: irrevocable

     

       348
       +
         unsubstantial: insubstantial

     

       349
       +
         usurpature: usurpation

     

       350
       +
         variative: variational

     

       351
       +
         vegetive: vegetative

     

       352
       +
         vindicative: vindictive

     

       353
       +
         vituperous: vituperative

     

       354
       +
         vociferant: vociferous

     

       355
       +
         volitive: volitional

     

       356
       +
         wolverene: wolverine

     

       357
       +
         wolvish: wolfish

     

       358
       +
         Zoroastrism: Zoroastrianism

+38

styles/proselint/Nonwords.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: "Consider using '%s' instead of '%s'."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       action:

     

       6
       +
         name: replace

     

       7
       +
       swap:

     

       8
       +
         affrontery: effrontery

     

       9
       +
         analyzation: analysis

     

       10
       +
         annoyment: annoyance

     

       11
       +
         confirmant: confirmand

     

       12
       +
         confirmants: confirmands

     

       13
       +
         conversate: converse

     

       14
       +
         crained: cranded

     

       15
       +
         discomforture: discomfort|discomfiture

     

       16
       +
         dispersement: disbursement|dispersal

     

       17
       +
         doubtlessly: doubtless|undoubtedly

     

       18
       +
         forebearance: forbearance

     

       19
       +
         improprietous: improper

     

       20
       +
         inclimate: inclement

     

       21
       +
         inimicable: inimical

     

       22
       +
         irregardless: regardless

     

       23
       +
         minimalize: minimize

     

       24
       +
         minimalized: minimized

     

       25
       +
         minimalizes: minimizes

     

       26
       +
         minimalizing: minimizing

     

       27
       +
         optimalize: optimize

     

       28
       +
         paralyzation: paralysis

     

       29
       +
         pettifogger: pettifog

     

       30
       +
         proprietous: proper

     

       31
       +
         relative inexpense: relatively low price|affordability

     

       32
       +
         seldomly: seldom

     

       33
       +
         thusly: thus

     

       34
       +
         uncategorically: categorically

     

       35
       +
         undoubtably: undoubtedly|indubitably

     

       36
       +
         unequivocable: unequivocal

     

       37
       +
         unmercilessly: mercilessly

     

       38
       +
         unrelentlessly: unrelentingly|relentlessly

+22

styles/proselint/Oxymorons.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is an oxymoron."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - amateur expert

     

       7
       +
         - increasingly less

     

       8
       +
         - advancing backwards

     

       9
       +
         - alludes explicitly to

     

       10
       +
         - explicitly alludes to

     

       11
       +
         - totally obsolescent

     

       12
       +
         - completely obsolescent

     

       13
       +
         - generally always

     

       14
       +
         - usually always

     

       15
       +
         - increasingly less

     

       16
       +
         - build down

     

       17
       +
         - conspicuous absence

     

       18
       +
         - exact estimate

     

       19
       +
         - found missing

     

       20
       +
         - intense apathy

     

       21
       +
         - mandatory choice

     

       22
       +
         - organized mess

styles/proselint/P-Value.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "You should use more decimal places, unless '%s' is really true."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: suggestion

     

       5
       +
       tokens:

     

       6
       +
         - 'p = 0\.0{2,4}'

+30

styles/proselint/RASSyndrome.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is redundant."

     

       3
       +
       level: error

     

       4
       +
       action:

     

       5
       +
         name: edit

     

       6
       +
         params:

     

       7
       +
          - split

     

       8
       +
          - ' '

     

       9
       +
          - '0'

     

       10
       +
       tokens:

     

       11
       +
         - ABM missile

     

       12
       +
         - ACT test

     

       13
       +
         - ABM missiles

     

       14
       +
         - ABS braking system

     

       15
       +
         - ATM machine

     

       16
       +
         - CD disc

     

       17
       +
         - CPI Index

     

       18
       +
         - GPS system

     

       19
       +
         - GUI interface

     

       20
       +
         - HIV virus

     

       21
       +
         - ISBN number

     

       22
       +
         - LCD display

     

       23
       +
         - PDF format

     

       24
       +
         - PIN number

     

       25
       +
         - RAS syndrome

     

       26
       +
         - RIP in peace

     

       27
       +
         - please RSVP

     

       28
       +
         - SALT talks

     

       29
       +
         - SAT test

     

       30
       +
         - UPC codes

+12

styles/proselint/README.md

···

1
+
Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross

2
+
All rights reserved.

3
+

4
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

5
+

6
+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

7
+

8
+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

9
+

10
+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

11
+

12
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+13

styles/proselint/Skunked.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is a bit of a skunked term — impossible to use without issue."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - bona fides

     

       7
       +
         - deceptively

     

       8
       +
         - decimate

     

       9
       +
         - effete

     

       10
       +
         - fulsome

     

       11
       +
         - hopefully

     

       12
       +
         - impassionate

     

       13
       +
         - Thankfully

+17

styles/proselint/Spelling.yml

···

       1
       +
       extends: consistency

     

       2
       +
       message: "Inconsistent spelling of '%s'."

     

       3
       +
       level: error

     

       4
       +
       ignorecase: true

     

       5
       +
       either:

     

       6
       +
         advisor: adviser

     

       7
       +
         centre: center

     

       8
       +
         colour: color

     

       9
       +
         emphasise: emphasize

     

       10
       +
         finalise: finalize

     

       11
       +
         focussed: focused

     

       12
       +
         labour: labor

     

       13
       +
         learnt: learned

     

       14
       +
         organise: organize

     

       15
       +
         organised: organized

     

       16
       +
         organising: organizing

     

       17
       +
         recognise: recognize

+11

styles/proselint/Typography.yml

···

       1
       +
       extends: substitution

     

       2
       +
       message: Consider using the '%s' symbol instead of '%s'.

     

       3
       +
       level: error

     

       4
       +
       nonword: true

     

       5
       +
       swap:

     

       6
       +
         '\.\.\.': …

     

       7
       +
         '\([cC]\)': ©

     

       8
       +
         '\(TM\)': ™

     

       9
       +
         '\(tm\)': ™

     

       10
       +
         '\([rR]\)': ®

     

       11
       +
         '[0-9]+ ?x ?[0-9]+': ×

+50

styles/proselint/Uncomparables.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is not comparable"

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       action:

     

       6
       +
         name: edit

     

       7
       +
         params:

     

       8
       +
          - split

     

       9
       +
          - ' '

     

       10
       +
          - '1'

     

       11
       +
       raw:

     

       12
       +
         - \b(?:absolutely|most|more|less|least|very|quite|largely|extremely|increasingly|kind of|mildy|hardly|greatly|sort of)\b\s*

     

       13
       +
       tokens:

     

       14
       +
         - absolute

     

       15
       +
         - adequate

     

       16
       +
         - complete

     

       17
       +
         - correct

     

       18
       +
         - certain

     

       19
       +
         - devoid

     

       20
       +
         - entire

     

       21
       +
         - 'false'

     

       22
       +
         - fatal

     

       23
       +
         - favorite

     

       24
       +
         - final

     

       25
       +
         - ideal

     

       26
       +
         - impossible

     

       27
       +
         - inevitable

     

       28
       +
         - infinite

     

       29
       +
         - irrevocable

     

       30
       +
         - main

     

       31
       +
         - manifest

     

       32
       +
         - only

     

       33
       +
         - paramount

     

       34
       +
         - perfect

     

       35
       +
         - perpetual

     

       36
       +
         - possible

     

       37
       +
         - preferable

     

       38
       +
         - principal

     

       39
       +
         - singular

     

       40
       +
         - stationary

     

       41
       +
         - sufficient

     

       42
       +
         - 'true'

     

       43
       +
         - unanimous

     

       44
       +
         - unavoidable

     

       45
       +
         - unbroken

     

       46
       +
         - uniform

     

       47
       +
         - unique

     

       48
       +
         - universal

     

       49
       +
         - void

     

       50
       +
         - whole

styles/proselint/Very.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Remove '%s'."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: error

     

       5
       +
       tokens:

     

       6
       +
         - very

+17

styles/proselint/meta.json

···

       1
       +
       {

     

       2
       +
         "author": "jdkato",

     

       3
       +
         "description": "A Vale-compatible implementation of the proselint linter.",

     

       4
       +
         "email": "support@errata.ai",

     

       5
       +
         "lang": "en",

     

       6
       +
         "url": "https://github.com/errata-ai/proselint/releases/latest/download/proselint.zip",

     

       7
       +
         "feed": "https://github.com/errata-ai/proselint/releases.atom",

     

       8
       +
         "issues": "https://github.com/errata-ai/proselint/issues/new",

     

       9
       +
         "license": "BSD-3-Clause",

     

       10
       +
         "name": "proselint",

     

       11
       +
         "sources": [

     

       12
       +
           "https://github.com/amperser/proselint"

     

       13
       +
         ],

     

       14
       +
         "vale_version": ">=1.0.0",

     

       15
       +
         "coverage": 0.0,

     

       16
       +
         "version": "0.1.0"

     

       17
       +
       }

+702

styles/write-good/Cliches.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Try to avoid using clichés like '%s'."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: warning

     

       5
       +
       tokens:

     

       6
       +
         - a chip off the old block

     

       7
       +
         - a clean slate

     

       8
       +
         - a dark and stormy night

     

       9
       +
         - a far cry

     

       10
       +
         - a fine kettle of fish

     

       11
       +
         - a loose cannon

     

       12
       +
         - a penny saved is a penny earned

     

       13
       +
         - a tough row to hoe

     

       14
       +
         - a word to the wise

     

       15
       +
         - ace in the hole

     

       16
       +
         - acid test

     

       17
       +
         - add insult to injury

     

       18
       +
         - against all odds

     

       19
       +
         - air your dirty laundry

     

       20
       +
         - all fun and games

     

       21
       +
         - all in a day's work

     

       22
       +
         - all talk, no action

     

       23
       +
         - all thumbs

     

       24
       +
         - all your eggs in one basket

     

       25
       +
         - all's fair in love and war

     

       26
       +
         - all's well that ends well

     

       27
       +
         - almighty dollar

     

       28
       +
         - American as apple pie

     

       29
       +
         - an axe to grind

     

       30
       +
         - another day, another dollar

     

       31
       +
         - armed to the teeth

     

       32
       +
         - as luck would have it

     

       33
       +
         - as old as time

     

       34
       +
         - as the crow flies

     

       35
       +
         - at loose ends

     

       36
       +
         - at my wits end

     

       37
       +
         - avoid like the plague

     

       38
       +
         - babe in the woods

     

       39
       +
         - back against the wall

     

       40
       +
         - back in the saddle

     

       41
       +
         - back to square one

     

       42
       +
         - back to the drawing board

     

       43
       +
         - bad to the bone

     

       44
       +
         - badge of honor

     

       45
       +
         - bald faced liar

     

       46
       +
         - ballpark figure

     

       47
       +
         - banging your head against a brick wall

     

       48
       +
         - baptism by fire

     

       49
       +
         - barking up the wrong tree

     

       50
       +
         - bat out of hell

     

       51
       +
         - be all and end all

     

       52
       +
         - beat a dead horse

     

       53
       +
         - beat around the bush

     

       54
       +
         - been there, done that

     

       55
       +
         - beggars can't be choosers

     

       56
       +
         - behind the eight ball

     

       57
       +
         - bend over backwards

     

       58
       +
         - benefit of the doubt

     

       59
       +
         - bent out of shape

     

       60
       +
         - best thing since sliced bread

     

       61
       +
         - bet your bottom dollar

     

       62
       +
         - better half

     

       63
       +
         - better late than never

     

       64
       +
         - better mousetrap

     

       65
       +
         - better safe than sorry

     

       66
       +
         - between a rock and a hard place

     

       67
       +
         - beyond the pale

     

       68
       +
         - bide your time

     

       69
       +
         - big as life

     

       70
       +
         - big cheese

     

       71
       +
         - big fish in a small pond

     

       72
       +
         - big man on campus

     

       73
       +
         - bigger they are the harder they fall

     

       74
       +
         - bird in the hand

     

       75
       +
         - bird's eye view

     

       76
       +
         - birds and the bees

     

       77
       +
         - birds of a feather flock together

     

       78
       +
         - bit the hand that feeds you

     

       79
       +
         - bite the bullet

     

       80
       +
         - bite the dust

     

       81
       +
         - bitten off more than he can chew

     

       82
       +
         - black as coal

     

       83
       +
         - black as pitch

     

       84
       +
         - black as the ace of spades

     

       85
       +
         - blast from the past

     

       86
       +
         - bleeding heart

     

       87
       +
         - blessing in disguise

     

       88
       +
         - blind ambition

     

       89
       +
         - blind as a bat

     

       90
       +
         - blind leading the blind

     

       91
       +
         - blood is thicker than water

     

       92
       +
         - blood sweat and tears

     

       93
       +
         - blow off steam

     

       94
       +
         - blow your own horn

     

       95
       +
         - blushing bride

     

       96
       +
         - boils down to

     

       97
       +
         - bolt from the blue

     

       98
       +
         - bone to pick

     

       99
       +
         - bored stiff

     

       100
       +
         - bored to tears

     

       101
       +
         - bottomless pit

     

       102
       +
         - boys will be boys

     

       103
       +
         - bright and early

     

       104
       +
         - brings home the bacon

     

       105
       +
         - broad across the beam

     

       106
       +
         - broken record

     

       107
       +
         - brought back to reality

     

       108
       +
         - bull by the horns

     

       109
       +
         - bull in a china shop

     

       110
       +
         - burn the midnight oil

     

       111
       +
         - burning question

     

       112
       +
         - burning the candle at both ends

     

       113
       +
         - burst your bubble

     

       114
       +
         - bury the hatchet

     

       115
       +
         - busy as a bee

     

       116
       +
         - by hook or by crook

     

       117
       +
         - call a spade a spade

     

       118
       +
         - called onto the carpet

     

       119
       +
         - calm before the storm

     

       120
       +
         - can of worms

     

       121
       +
         - can't cut the mustard

     

       122
       +
         - can't hold a candle to

     

       123
       +
         - case of mistaken identity

     

       124
       +
         - cat got your tongue

     

       125
       +
         - cat's meow

     

       126
       +
         - caught in the crossfire

     

       127
       +
         - caught red-handed

     

       128
       +
         - checkered past

     

       129
       +
         - chomping at the bit

     

       130
       +
         - cleanliness is next to godliness

     

       131
       +
         - clear as a bell

     

       132
       +
         - clear as mud

     

       133
       +
         - close to the vest

     

       134
       +
         - cock and bull story

     

       135
       +
         - cold shoulder

     

       136
       +
         - come hell or high water

     

       137
       +
         - cool as a cucumber

     

       138
       +
         - cool, calm, and collected

     

       139
       +
         - cost a king's ransom

     

       140
       +
         - count your blessings

     

       141
       +
         - crack of dawn

     

       142
       +
         - crash course

     

       143
       +
         - creature comforts

     

       144
       +
         - cross that bridge when you come to it

     

       145
       +
         - crushing blow

     

       146
       +
         - cry like a baby

     

       147
       +
         - cry me a river

     

       148
       +
         - cry over spilt milk

     

       149
       +
         - crystal clear

     

       150
       +
         - curiosity killed the cat

     

       151
       +
         - cut and dried

     

       152
       +
         - cut through the red tape

     

       153
       +
         - cut to the chase

     

       154
       +
         - cute as a bugs ear

     

       155
       +
         - cute as a button

     

       156
       +
         - cute as a puppy

     

       157
       +
         - cuts to the quick

     

       158
       +
         - dark before the dawn

     

       159
       +
         - day in, day out

     

       160
       +
         - dead as a doornail

     

       161
       +
         - devil is in the details

     

       162
       +
         - dime a dozen

     

       163
       +
         - divide and conquer

     

       164
       +
         - dog and pony show

     

       165
       +
         - dog days

     

       166
       +
         - dog eat dog

     

       167
       +
         - dog tired

     

       168
       +
         - don't burn your bridges

     

       169
       +
         - don't count your chickens

     

       170
       +
         - don't look a gift horse in the mouth

     

       171
       +
         - don't rock the boat

     

       172
       +
         - don't step on anyone's toes

     

       173
       +
         - don't take any wooden nickels

     

       174
       +
         - down and out

     

       175
       +
         - down at the heels

     

       176
       +
         - down in the dumps

     

       177
       +
         - down the hatch

     

       178
       +
         - down to earth

     

       179
       +
         - draw the line

     

       180
       +
         - dressed to kill

     

       181
       +
         - dressed to the nines

     

       182
       +
         - drives me up the wall

     

       183
       +
         - dull as dishwater

     

       184
       +
         - dyed in the wool

     

       185
       +
         - eagle eye

     

       186
       +
         - ear to the ground

     

       187
       +
         - early bird catches the worm

     

       188
       +
         - easier said than done

     

       189
       +
         - easy as pie

     

       190
       +
         - eat your heart out

     

       191
       +
         - eat your words

     

       192
       +
         - eleventh hour

     

       193
       +
         - even the playing field

     

       194
       +
         - every dog has its day

     

       195
       +
         - every fiber of my being

     

       196
       +
         - everything but the kitchen sink

     

       197
       +
         - eye for an eye

     

       198
       +
         - face the music

     

       199
       +
         - facts of life

     

       200
       +
         - fair weather friend

     

       201
       +
         - fall by the wayside

     

       202
       +
         - fan the flames

     

       203
       +
         - feast or famine

     

       204
       +
         - feather your nest

     

       205
       +
         - feathered friends

     

       206
       +
         - few and far between

     

       207
       +
         - fifteen minutes of fame

     

       208
       +
         - filthy vermin

     

       209
       +
         - fine kettle of fish

     

       210
       +
         - fish out of water

     

       211
       +
         - fishing for a compliment

     

       212
       +
         - fit as a fiddle

     

       213
       +
         - fit the bill

     

       214
       +
         - fit to be tied

     

       215
       +
         - flash in the pan

     

       216
       +
         - flat as a pancake

     

       217
       +
         - flip your lid

     

       218
       +
         - flog a dead horse

     

       219
       +
         - fly by night

     

       220
       +
         - fly the coop

     

       221
       +
         - follow your heart

     

       222
       +
         - for all intents and purposes

     

       223
       +
         - for the birds

     

       224
       +
         - for what it's worth

     

       225
       +
         - force of nature

     

       226
       +
         - force to be reckoned with

     

       227
       +
         - forgive and forget

     

       228
       +
         - fox in the henhouse

     

       229
       +
         - free and easy

     

       230
       +
         - free as a bird

     

       231
       +
         - fresh as a daisy

     

       232
       +
         - full steam ahead

     

       233
       +
         - fun in the sun

     

       234
       +
         - garbage in, garbage out

     

       235
       +
         - gentle as a lamb

     

       236
       +
         - get a kick out of

     

       237
       +
         - get a leg up

     

       238
       +
         - get down and dirty

     

       239
       +
         - get the lead out

     

       240
       +
         - get to the bottom of

     

       241
       +
         - get your feet wet

     

       242
       +
         - gets my goat

     

       243
       +
         - gilding the lily

     

       244
       +
         - give and take

     

       245
       +
         - go against the grain

     

       246
       +
         - go at it tooth and nail

     

       247
       +
         - go for broke

     

       248
       +
         - go him one better

     

       249
       +
         - go the extra mile

     

       250
       +
         - go with the flow

     

       251
       +
         - goes without saying

     

       252
       +
         - good as gold

     

       253
       +
         - good deed for the day

     

       254
       +
         - good things come to those who wait

     

       255
       +
         - good time was had by all

     

       256
       +
         - good times were had by all

     

       257
       +
         - greased lightning

     

       258
       +
         - greek to me

     

       259
       +
         - green thumb

     

       260
       +
         - green-eyed monster

     

       261
       +
         - grist for the mill

     

       262
       +
         - growing like a weed

     

       263
       +
         - hair of the dog

     

       264
       +
         - hand to mouth

     

       265
       +
         - happy as a clam

     

       266
       +
         - happy as a lark

     

       267
       +
         - hasn't a clue

     

       268
       +
         - have a nice day

     

       269
       +
         - have high hopes

     

       270
       +
         - have the last laugh

     

       271
       +
         - haven't got a row to hoe

     

       272
       +
         - head honcho

     

       273
       +
         - head over heels

     

       274
       +
         - hear a pin drop

     

       275
       +
         - heard it through the grapevine

     

       276
       +
         - heart's content

     

       277
       +
         - heavy as lead

     

       278
       +
         - hem and haw

     

       279
       +
         - high and dry

     

       280
       +
         - high and mighty

     

       281
       +
         - high as a kite

     

       282
       +
         - hit paydirt

     

       283
       +
         - hold your head up high

     

       284
       +
         - hold your horses

     

       285
       +
         - hold your own

     

       286
       +
         - hold your tongue

     

       287
       +
         - honest as the day is long

     

       288
       +
         - horns of a dilemma

     

       289
       +
         - horse of a different color

     

       290
       +
         - hot under the collar

     

       291
       +
         - hour of need

     

       292
       +
         - I beg to differ

     

       293
       +
         - icing on the cake

     

       294
       +
         - if the shoe fits

     

       295
       +
         - if the shoe were on the other foot

     

       296
       +
         - in a jam

     

       297
       +
         - in a jiffy

     

       298
       +
         - in a nutshell

     

       299
       +
         - in a pig's eye

     

       300
       +
         - in a pinch

     

       301
       +
         - in a word

     

       302
       +
         - in hot water

     

       303
       +
         - in the gutter

     

       304
       +
         - in the nick of time

     

       305
       +
         - in the thick of it

     

       306
       +
         - in your dreams

     

       307
       +
         - it ain't over till the fat lady sings

     

       308
       +
         - it goes without saying

     

       309
       +
         - it takes all kinds

     

       310
       +
         - it takes one to know one

     

       311
       +
         - it's a small world

     

       312
       +
         - it's only a matter of time

     

       313
       +
         - ivory tower

     

       314
       +
         - Jack of all trades

     

       315
       +
         - jockey for position

     

       316
       +
         - jog your memory

     

       317
       +
         - joined at the hip

     

       318
       +
         - judge a book by its cover

     

       319
       +
         - jump down your throat

     

       320
       +
         - jump in with both feet

     

       321
       +
         - jump on the bandwagon

     

       322
       +
         - jump the gun

     

       323
       +
         - jump to conclusions

     

       324
       +
         - just a hop, skip, and a jump

     

       325
       +
         - just the ticket

     

       326
       +
         - justice is blind

     

       327
       +
         - keep a stiff upper lip

     

       328
       +
         - keep an eye on

     

       329
       +
         - keep it simple, stupid

     

       330
       +
         - keep the home fires burning

     

       331
       +
         - keep up with the Joneses

     

       332
       +
         - keep your chin up

     

       333
       +
         - keep your fingers crossed

     

       334
       +
         - kick the bucket

     

       335
       +
         - kick up your heels

     

       336
       +
         - kick your feet up

     

       337
       +
         - kid in a candy store

     

       338
       +
         - kill two birds with one stone

     

       339
       +
         - kiss of death

     

       340
       +
         - knock it out of the park

     

       341
       +
         - knock on wood

     

       342
       +
         - knock your socks off

     

       343
       +
         - know him from Adam

     

       344
       +
         - know the ropes

     

       345
       +
         - know the score

     

       346
       +
         - knuckle down

     

       347
       +
         - knuckle sandwich

     

       348
       +
         - knuckle under

     

       349
       +
         - labor of love

     

       350
       +
         - ladder of success

     

       351
       +
         - land on your feet

     

       352
       +
         - lap of luxury

     

       353
       +
         - last but not least

     

       354
       +
         - last hurrah

     

       355
       +
         - last-ditch effort

     

       356
       +
         - law of the jungle

     

       357
       +
         - law of the land

     

       358
       +
         - lay down the law

     

       359
       +
         - leaps and bounds

     

       360
       +
         - let sleeping dogs lie

     

       361
       +
         - let the cat out of the bag

     

       362
       +
         - let the good times roll

     

       363
       +
         - let your hair down

     

       364
       +
         - let's talk turkey

     

       365
       +
         - letter perfect

     

       366
       +
         - lick your wounds

     

       367
       +
         - lies like a rug

     

       368
       +
         - life's a bitch

     

       369
       +
         - life's a grind

     

       370
       +
         - light at the end of the tunnel

     

       371
       +
         - lighter than a feather

     

       372
       +
         - lighter than air

     

       373
       +
         - like clockwork

     

       374
       +
         - like father like son

     

       375
       +
         - like taking candy from a baby

     

       376
       +
         - like there's no tomorrow

     

       377
       +
         - lion's share

     

       378
       +
         - live and learn

     

       379
       +
         - live and let live

     

       380
       +
         - long and short of it

     

       381
       +
         - long lost love

     

       382
       +
         - look before you leap

     

       383
       +
         - look down your nose

     

       384
       +
         - look what the cat dragged in

     

       385
       +
         - looking a gift horse in the mouth

     

       386
       +
         - looks like death warmed over

     

       387
       +
         - loose cannon

     

       388
       +
         - lose your head

     

       389
       +
         - lose your temper

     

       390
       +
         - loud as a horn

     

       391
       +
         - lounge lizard

     

       392
       +
         - loved and lost

     

       393
       +
         - low man on the totem pole

     

       394
       +
         - luck of the draw

     

       395
       +
         - luck of the Irish

     

       396
       +
         - make hay while the sun shines

     

       397
       +
         - make money hand over fist

     

       398
       +
         - make my day

     

       399
       +
         - make the best of a bad situation

     

       400
       +
         - make the best of it

     

       401
       +
         - make your blood boil

     

       402
       +
         - man of few words

     

       403
       +
         - man's best friend

     

       404
       +
         - mark my words

     

       405
       +
         - meaningful dialogue

     

       406
       +
         - missed the boat on that one

     

       407
       +
         - moment in the sun

     

       408
       +
         - moment of glory

     

       409
       +
         - moment of truth

     

       410
       +
         - money to burn

     

       411
       +
         - more power to you

     

       412
       +
         - more than one way to skin a cat

     

       413
       +
         - movers and shakers

     

       414
       +
         - moving experience

     

       415
       +
         - naked as a jaybird

     

       416
       +
         - naked truth

     

       417
       +
         - neat as a pin

     

       418
       +
         - needle in a haystack

     

       419
       +
         - needless to say

     

       420
       +
         - neither here nor there

     

       421
       +
         - never look back

     

       422
       +
         - never say never

     

       423
       +
         - nip and tuck

     

       424
       +
         - nip it in the bud

     

       425
       +
         - no guts, no glory

     

       426
       +
         - no love lost

     

       427
       +
         - no pain, no gain

     

       428
       +
         - no skin off my back

     

       429
       +
         - no stone unturned

     

       430
       +
         - no time like the present

     

       431
       +
         - no use crying over spilled milk

     

       432
       +
         - nose to the grindstone

     

       433
       +
         - not a hope in hell

     

       434
       +
         - not a minute's peace

     

       435
       +
         - not in my backyard

     

       436
       +
         - not playing with a full deck

     

       437
       +
         - not the end of the world

     

       438
       +
         - not written in stone

     

       439
       +
         - nothing to sneeze at

     

       440
       +
         - nothing ventured nothing gained

     

       441
       +
         - now we're cooking

     

       442
       +
         - off the top of my head

     

       443
       +
         - off the wagon

     

       444
       +
         - off the wall

     

       445
       +
         - old hat

     

       446
       +
         - older and wiser

     

       447
       +
         - older than dirt

     

       448
       +
         - older than Methuselah

     

       449
       +
         - on a roll

     

       450
       +
         - on cloud nine

     

       451
       +
         - on pins and needles

     

       452
       +
         - on the bandwagon

     

       453
       +
         - on the money

     

       454
       +
         - on the nose

     

       455
       +
         - on the rocks

     

       456
       +
         - on the spot

     

       457
       +
         - on the tip of my tongue

     

       458
       +
         - on the wagon

     

       459
       +
         - on thin ice

     

       460
       +
         - once bitten, twice shy

     

       461
       +
         - one bad apple doesn't spoil the bushel

     

       462
       +
         - one born every minute

     

       463
       +
         - one brick short

     

       464
       +
         - one foot in the grave

     

       465
       +
         - one in a million

     

       466
       +
         - one red cent

     

       467
       +
         - only game in town

     

       468
       +
         - open a can of worms

     

       469
       +
         - open and shut case

     

       470
       +
         - open the flood gates

     

       471
       +
         - opportunity doesn't knock twice

     

       472
       +
         - out of pocket

     

       473
       +
         - out of sight, out of mind

     

       474
       +
         - out of the frying pan into the fire

     

       475
       +
         - out of the woods

     

       476
       +
         - out on a limb

     

       477
       +
         - over a barrel

     

       478
       +
         - over the hump

     

       479
       +
         - pain and suffering

     

       480
       +
         - pain in the

     

       481
       +
         - panic button

     

       482
       +
         - par for the course

     

       483
       +
         - part and parcel

     

       484
       +
         - party pooper

     

       485
       +
         - pass the buck

     

       486
       +
         - patience is a virtue

     

       487
       +
         - pay through the nose

     

       488
       +
         - penny pincher

     

       489
       +
         - perfect storm

     

       490
       +
         - pig in a poke

     

       491
       +
         - pile it on

     

       492
       +
         - pillar of the community

     

       493
       +
         - pin your hopes on

     

       494
       +
         - pitter patter of little feet

     

       495
       +
         - plain as day

     

       496
       +
         - plain as the nose on your face

     

       497
       +
         - play by the rules

     

       498
       +
         - play your cards right

     

       499
       +
         - playing the field

     

       500
       +
         - playing with fire

     

       501
       +
         - pleased as punch

     

       502
       +
         - plenty of fish in the sea

     

       503
       +
         - point with pride

     

       504
       +
         - poor as a church mouse

     

       505
       +
         - pot calling the kettle black

     

       506
       +
         - pretty as a picture

     

       507
       +
         - pull a fast one

     

       508
       +
         - pull your punches

     

       509
       +
         - pulling your leg

     

       510
       +
         - pure as the driven snow

     

       511
       +
         - put it in a nutshell

     

       512
       +
         - put one over on you

     

       513
       +
         - put the cart before the horse

     

       514
       +
         - put the pedal to the metal

     

       515
       +
         - put your best foot forward

     

       516
       +
         - put your foot down

     

       517
       +
         - quick as a bunny

     

       518
       +
         - quick as a lick

     

       519
       +
         - quick as a wink

     

       520
       +
         - quick as lightning

     

       521
       +
         - quiet as a dormouse

     

       522
       +
         - rags to riches

     

       523
       +
         - raining buckets

     

       524
       +
         - raining cats and dogs

     

       525
       +
         - rank and file

     

       526
       +
         - rat race

     

       527
       +
         - reap what you sow

     

       528
       +
         - red as a beet

     

       529
       +
         - red herring

     

       530
       +
         - reinvent the wheel

     

       531
       +
         - rich and famous

     

       532
       +
         - rings a bell

     

       533
       +
         - ripe old age

     

       534
       +
         - ripped me off

     

       535
       +
         - rise and shine

     

       536
       +
         - road to hell is paved with good intentions

     

       537
       +
         - rob Peter to pay Paul

     

       538
       +
         - roll over in the grave

     

       539
       +
         - rub the wrong way

     

       540
       +
         - ruled the roost

     

       541
       +
         - running in circles

     

       542
       +
         - sad but true

     

       543
       +
         - sadder but wiser

     

       544
       +
         - salt of the earth

     

       545
       +
         - scared stiff

     

       546
       +
         - scared to death

     

       547
       +
         - sealed with a kiss

     

       548
       +
         - second to none

     

       549
       +
         - see eye to eye

     

       550
       +
         - seen the light

     

       551
       +
         - seize the day

     

       552
       +
         - set the record straight

     

       553
       +
         - set the world on fire

     

       554
       +
         - set your teeth on edge

     

       555
       +
         - sharp as a tack

     

       556
       +
         - shoot for the moon

     

       557
       +
         - shoot the breeze

     

       558
       +
         - shot in the dark

     

       559
       +
         - shoulder to the wheel

     

       560
       +
         - sick as a dog

     

       561
       +
         - sigh of relief

     

       562
       +
         - signed, sealed, and delivered

     

       563
       +
         - sink or swim

     

       564
       +
         - six of one, half a dozen of another

     

       565
       +
         - skating on thin ice

     

       566
       +
         - slept like a log

     

       567
       +
         - slinging mud

     

       568
       +
         - slippery as an eel

     

       569
       +
         - slow as molasses

     

       570
       +
         - smart as a whip

     

       571
       +
         - smooth as a baby's bottom

     

       572
       +
         - sneaking suspicion

     

       573
       +
         - snug as a bug in a rug

     

       574
       +
         - sow wild oats

     

       575
       +
         - spare the rod, spoil the child

     

       576
       +
         - speak of the devil

     

       577
       +
         - spilled the beans

     

       578
       +
         - spinning your wheels

     

       579
       +
         - spitting image of

     

       580
       +
         - spoke with relish

     

       581
       +
         - spread like wildfire

     

       582
       +
         - spring to life

     

       583
       +
         - squeaky wheel gets the grease

     

       584
       +
         - stands out like a sore thumb

     

       585
       +
         - start from scratch

     

       586
       +
         - stick in the mud

     

       587
       +
         - still waters run deep

     

       588
       +
         - stitch in time

     

       589
       +
         - stop and smell the roses

     

       590
       +
         - straight as an arrow

     

       591
       +
         - straw that broke the camel's back

     

       592
       +
         - strong as an ox

     

       593
       +
         - stubborn as a mule

     

       594
       +
         - stuff that dreams are made of

     

       595
       +
         - stuffed shirt

     

       596
       +
         - sweating blood

     

       597
       +
         - sweating bullets

     

       598
       +
         - take a load off

     

       599
       +
         - take one for the team

     

       600
       +
         - take the bait

     

       601
       +
         - take the bull by the horns

     

       602
       +
         - take the plunge

     

       603
       +
         - takes one to know one

     

       604
       +
         - takes two to tango

     

       605
       +
         - the more the merrier

     

       606
       +
         - the real deal

     

       607
       +
         - the real McCoy

     

       608
       +
         - the red carpet treatment

     

       609
       +
         - the same old story

     

       610
       +
         - there is no accounting for taste

     

       611
       +
         - thick as a brick

     

       612
       +
         - thick as thieves

     

       613
       +
         - thin as a rail

     

       614
       +
         - think outside of the box

     

       615
       +
         - third time's the charm

     

       616
       +
         - this day and age

     

       617
       +
         - this hurts me worse than it hurts you

     

       618
       +
         - this point in time

     

       619
       +
         - three sheets to the wind

     

       620
       +
         - through thick and thin

     

       621
       +
         - throw in the towel

     

       622
       +
         - tie one on

     

       623
       +
         - tighter than a drum

     

       624
       +
         - time and time again

     

       625
       +
         - time is of the essence

     

       626
       +
         - tip of the iceberg

     

       627
       +
         - tired but happy

     

       628
       +
         - to coin a phrase

     

       629
       +
         - to each his own

     

       630
       +
         - to make a long story short

     

       631
       +
         - to the best of my knowledge

     

       632
       +
         - toe the line

     

       633
       +
         - tongue in cheek

     

       634
       +
         - too good to be true

     

       635
       +
         - too hot to handle

     

       636
       +
         - too numerous to mention

     

       637
       +
         - touch with a ten foot pole

     

       638
       +
         - tough as nails

     

       639
       +
         - trial and error

     

       640
       +
         - trials and tribulations

     

       641
       +
         - tried and true

     

       642
       +
         - trip down memory lane

     

       643
       +
         - twist of fate

     

       644
       +
         - two cents worth

     

       645
       +
         - two peas in a pod

     

       646
       +
         - ugly as sin

     

       647
       +
         - under the counter

     

       648
       +
         - under the gun

     

       649
       +
         - under the same roof

     

       650
       +
         - under the weather

     

       651
       +
         - until the cows come home

     

       652
       +
         - unvarnished truth

     

       653
       +
         - up the creek

     

       654
       +
         - uphill battle

     

       655
       +
         - upper crust

     

       656
       +
         - upset the applecart

     

       657
       +
         - vain attempt

     

       658
       +
         - vain effort

     

       659
       +
         - vanquish the enemy

     

       660
       +
         - vested interest

     

       661
       +
         - waiting for the other shoe to drop

     

       662
       +
         - wakeup call

     

       663
       +
         - warm welcome

     

       664
       +
         - watch your p's and q's

     

       665
       +
         - watch your tongue

     

       666
       +
         - watching the clock

     

       667
       +
         - water under the bridge

     

       668
       +
         - weather the storm

     

       669
       +
         - weed them out

     

       670
       +
         - week of Sundays

     

       671
       +
         - went belly up

     

       672
       +
         - wet behind the ears

     

       673
       +
         - what goes around comes around

     

       674
       +
         - what you see is what you get

     

       675
       +
         - when it rains, it pours

     

       676
       +
         - when push comes to shove

     

       677
       +
         - when the cat's away

     

       678
       +
         - when the going gets tough, the tough get going

     

       679
       +
         - white as a sheet

     

       680
       +
         - whole ball of wax

     

       681
       +
         - whole hog

     

       682
       +
         - whole nine yards

     

       683
       +
         - wild goose chase

     

       684
       +
         - will wonders never cease?

     

       685
       +
         - wisdom of the ages

     

       686
       +
         - wise as an owl

     

       687
       +
         - wolf at the door

     

       688
       +
         - words fail me

     

       689
       +
         - work like a dog

     

       690
       +
         - world weary

     

       691
       +
         - worst nightmare

     

       692
       +
         - worth its weight in gold

     

       693
       +
         - wrong side of the bed

     

       694
       +
         - yanking your chain

     

       695
       +
         - yappy as a dog

     

       696
       +
         - years young

     

       697
       +
         - you are what you eat

     

       698
       +
         - you can run but you can't hide

     

       699
       +
         - you only live once

     

       700
       +
         - you're the boss

     

       701
       +
         - young and foolish

     

       702
       +
         - young and vibrant

+32

styles/write-good/E-Prime.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Try to avoid using '%s'."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: suggestion

     

       5
       +
       tokens:

     

       6
       +
         - am

     

       7
       +
         - are

     

       8
       +
         - aren't

     

       9
       +
         - be

     

       10
       +
         - been

     

       11
       +
         - being

     

       12
       +
         - he's

     

       13
       +
         - here's

     

       14
       +
         - here's

     

       15
       +
         - how's

     

       16
       +
         - i'm

     

       17
       +
         - is

     

       18
       +
         - isn't

     

       19
       +
         - it's

     

       20
       +
         - she's

     

       21
       +
         - that's

     

       22
       +
         - there's

     

       23
       +
         - they're

     

       24
       +
         - was

     

       25
       +
         - wasn't

     

       26
       +
         - we're

     

       27
       +
         - were

     

       28
       +
         - weren't

     

       29
       +
         - what's

     

       30
       +
         - where's

     

       31
       +
         - who's

     

       32
       +
         - you're

+11

styles/write-good/Illusions.yml

···

       1
       +
       extends: repetition

     

       2
       +
       message: "'%s' is repeated!"

     

       3
       +
       level: error

     

       4
       +
       alpha: true

     

       5
       +
       action:

     

       6
       +
         name: edit

     

       7
       +
         params:

     

       8
       +
           - truncate

     

       9
       +
           - " "

     

       10
       +
       tokens:

     

       11
       +
         - '[^\s]+'

+183

styles/write-good/Passive.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' may be passive voice. Use active voice if you can."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: warning

     

       5
       +
       raw:

     

       6
       +
         - \b(am|are|were|being|is|been|was|be)\b\s*

     

       7
       +
       tokens:

     

       8
       +
         - '[\w]+ed'

     

       9
       +
         - awoken

     

       10
       +
         - beat

     

       11
       +
         - become

     

       12
       +
         - been

     

       13
       +
         - begun

     

       14
       +
         - bent

     

       15
       +
         - beset

     

       16
       +
         - bet

     

       17
       +
         - bid

     

       18
       +
         - bidden

     

       19
       +
         - bitten

     

       20
       +
         - bled

     

       21
       +
         - blown

     

       22
       +
         - born

     

       23
       +
         - bought

     

       24
       +
         - bound

     

       25
       +
         - bred

     

       26
       +
         - broadcast

     

       27
       +
         - broken

     

       28
       +
         - brought

     

       29
       +
         - built

     

       30
       +
         - burnt

     

       31
       +
         - burst

     

       32
       +
         - cast

     

       33
       +
         - caught

     

       34
       +
         - chosen

     

       35
       +
         - clung

     

       36
       +
         - come

     

       37
       +
         - cost

     

       38
       +
         - crept

     

       39
       +
         - cut

     

       40
       +
         - dealt

     

       41
       +
         - dived

     

       42
       +
         - done

     

       43
       +
         - drawn

     

       44
       +
         - dreamt

     

       45
       +
         - driven

     

       46
       +
         - drunk

     

       47
       +
         - dug

     

       48
       +
         - eaten

     

       49
       +
         - fallen

     

       50
       +
         - fed

     

       51
       +
         - felt

     

       52
       +
         - fit

     

       53
       +
         - fled

     

       54
       +
         - flown

     

       55
       +
         - flung

     

       56
       +
         - forbidden

     

       57
       +
         - foregone

     

       58
       +
         - forgiven

     

       59
       +
         - forgotten

     

       60
       +
         - forsaken

     

       61
       +
         - fought

     

       62
       +
         - found

     

       63
       +
         - frozen

     

       64
       +
         - given

     

       65
       +
         - gone

     

       66
       +
         - gotten

     

       67
       +
         - ground

     

       68
       +
         - grown

     

       69
       +
         - heard

     

       70
       +
         - held

     

       71
       +
         - hidden

     

       72
       +
         - hit

     

       73
       +
         - hung

     

       74
       +
         - hurt

     

       75
       +
         - kept

     

       76
       +
         - knelt

     

       77
       +
         - knit

     

       78
       +
         - known

     

       79
       +
         - laid

     

       80
       +
         - lain

     

       81
       +
         - leapt

     

       82
       +
         - learnt

     

       83
       +
         - led

     

       84
       +
         - left

     

       85
       +
         - lent

     

       86
       +
         - let

     

       87
       +
         - lighted

     

       88
       +
         - lost

     

       89
       +
         - made

     

       90
       +
         - meant

     

       91
       +
         - met

     

       92
       +
         - misspelt

     

       93
       +
         - mistaken

     

       94
       +
         - mown

     

       95
       +
         - overcome

     

       96
       +
         - overdone

     

       97
       +
         - overtaken

     

       98
       +
         - overthrown

     

       99
       +
         - paid

     

       100
       +
         - pled

     

       101
       +
         - proven

     

       102
       +
         - put

     

       103
       +
         - quit

     

       104
       +
         - read

     

       105
       +
         - rid

     

       106
       +
         - ridden

     

       107
       +
         - risen

     

       108
       +
         - run

     

       109
       +
         - rung

     

       110
       +
         - said

     

       111
       +
         - sat

     

       112
       +
         - sawn

     

       113
       +
         - seen

     

       114
       +
         - sent

     

       115
       +
         - set

     

       116
       +
         - sewn

     

       117
       +
         - shaken

     

       118
       +
         - shaven

     

       119
       +
         - shed

     

       120
       +
         - shod

     

       121
       +
         - shone

     

       122
       +
         - shorn

     

       123
       +
         - shot

     

       124
       +
         - shown

     

       125
       +
         - shrunk

     

       126
       +
         - shut

     

       127
       +
         - slain

     

       128
       +
         - slept

     

       129
       +
         - slid

     

       130
       +
         - slit

     

       131
       +
         - slung

     

       132
       +
         - smitten

     

       133
       +
         - sold

     

       134
       +
         - sought

     

       135
       +
         - sown

     

       136
       +
         - sped

     

       137
       +
         - spent

     

       138
       +
         - spilt

     

       139
       +
         - spit

     

       140
       +
         - split

     

       141
       +
         - spoken

     

       142
       +
         - spread

     

       143
       +
         - sprung

     

       144
       +
         - spun

     

       145
       +
         - stolen

     

       146
       +
         - stood

     

       147
       +
         - stridden

     

       148
       +
         - striven

     

       149
       +
         - struck

     

       150
       +
         - strung

     

       151
       +
         - stuck

     

       152
       +
         - stung

     

       153
       +
         - stunk

     

       154
       +
         - sung

     

       155
       +
         - sunk

     

       156
       +
         - swept

     

       157
       +
         - swollen

     

       158
       +
         - sworn

     

       159
       +
         - swum

     

       160
       +
         - swung

     

       161
       +
         - taken

     

       162
       +
         - taught

     

       163
       +
         - thought

     

       164
       +
         - thrived

     

       165
       +
         - thrown

     

       166
       +
         - thrust

     

       167
       +
         - told

     

       168
       +
         - torn

     

       169
       +
         - trodden

     

       170
       +
         - understood

     

       171
       +
         - upheld

     

       172
       +
         - upset

     

       173
       +
         - wed

     

       174
       +
         - wept

     

       175
       +
         - withheld

     

       176
       +
         - withstood

     

       177
       +
         - woken

     

       178
       +
         - won

     

       179
       +
         - worn

     

       180
       +
         - wound

     

       181
       +
         - woven

     

       182
       +
         - written

     

       183
       +
         - wrung

+27

styles/write-good/README.md

···

       1
       +
       Based on [write-good](https://github.com/btford/write-good).

     

       2
       +
       

     

       3
       +
       > Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.

     

       4
       +
       

     

       5
       +
       ```

     

       6
       +
       The MIT License (MIT)

     

       7
       +
       

     

       8
       +
       Copyright (c) 2014 Brian Ford

     

       9
       +
       

     

       10
       +
       Permission is hereby granted, free of charge, to any person obtaining a copy

     

       11
       +
       of this software and associated documentation files (the "Software"), to deal

     

       12
       +
       in the Software without restriction, including without limitation the rights

     

       13
       +
       to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

     

       14
       +
       copies of the Software, and to permit persons to whom the Software is

     

       15
       +
       furnished to do so, subject to the following conditions:

     

       16
       +
       

     

       17
       +
       The above copyright notice and this permission notice shall be included in all

     

       18
       +
       copies or substantial portions of the Software.

     

       19
       +
       

     

       20
       +
       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

     

       21
       +
       IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

     

       22
       +
       FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

     

       23
       +
       AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

     

       24
       +
       LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

     

       25
       +
       OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

     

       26
       +
       SOFTWARE.

     

       27
       +
       ```

styles/write-good/So.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Don't start a sentence with '%s'."

     

       3
       +
       level: error

     

       4
       +
       raw:

     

       5
       +
         - '(?:[;-]\s)so[\s,]|\bSo[\s,]'

styles/write-good/ThereIs.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "Don't start a sentence with '%s'."

     

       3
       +
       ignorecase: false

     

       4
       +
       level: error

     

       5
       +
       raw:

     

       6
       +
         - '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b'

+221

styles/write-good/TooWordy.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is too wordy."

     

       3
       +
       ignorecase: true

     

       4
       +
       level: warning

     

       5
       +
       tokens:

     

       6
       +
         - a number of

     

       7
       +
         - abundance

     

       8
       +
         - accede to

     

       9
       +
         - accelerate

     

       10
       +
         - accentuate

     

       11
       +
         - accompany

     

       12
       +
         - accomplish

     

       13
       +
         - accorded

     

       14
       +
         - accrue

     

       15
       +
         - acquiesce

     

       16
       +
         - acquire

     

       17
       +
         - additional

     

       18
       +
         - adjacent to

     

       19
       +
         - adjustment

     

       20
       +
         - admissible

     

       21
       +
         - advantageous

     

       22
       +
         - adversely impact

     

       23
       +
         - advise

     

       24
       +
         - aforementioned

     

       25
       +
         - aggregate

     

       26
       +
         - aircraft

     

       27
       +
         - all of

     

       28
       +
         - all things considered

     

       29
       +
         - alleviate

     

       30
       +
         - allocate

     

       31
       +
         - along the lines of

     

       32
       +
         - already existing

     

       33
       +
         - alternatively

     

       34
       +
         - amazing

     

       35
       +
         - ameliorate

     

       36
       +
         - anticipate

     

       37
       +
         - apparent

     

       38
       +
         - appreciable

     

       39
       +
         - as a matter of fact

     

       40
       +
         - as a means of

     

       41
       +
         - as far as I'm concerned

     

       42
       +
         - as of yet

     

       43
       +
         - as to

     

       44
       +
         - as yet

     

       45
       +
         - ascertain

     

       46
       +
         - assistance

     

       47
       +
         - at the present time

     

       48
       +
         - at this time

     

       49
       +
         - attain

     

       50
       +
         - attributable to

     

       51
       +
         - authorize

     

       52
       +
         - because of the fact that

     

       53
       +
         - belated

     

       54
       +
         - benefit from

     

       55
       +
         - bestow

     

       56
       +
         - by means of

     

       57
       +
         - by virtue of

     

       58
       +
         - by virtue of the fact that

     

       59
       +
         - cease

     

       60
       +
         - close proximity

     

       61
       +
         - commence

     

       62
       +
         - comply with

     

       63
       +
         - concerning

     

       64
       +
         - consequently

     

       65
       +
         - consolidate

     

       66
       +
         - constitutes

     

       67
       +
         - demonstrate

     

       68
       +
         - depart

     

       69
       +
         - designate

     

       70
       +
         - discontinue

     

       71
       +
         - due to the fact that

     

       72
       +
         - each and every

     

       73
       +
         - economical

     

       74
       +
         - eliminate

     

       75
       +
         - elucidate

     

       76
       +
         - employ

     

       77
       +
         - endeavor

     

       78
       +
         - enumerate

     

       79
       +
         - equitable

     

       80
       +
         - equivalent

     

       81
       +
         - evaluate

     

       82
       +
         - evidenced

     

       83
       +
         - exclusively

     

       84
       +
         - expedite

     

       85
       +
         - expend

     

       86
       +
         - expiration

     

       87
       +
         - facilitate

     

       88
       +
         - factual evidence

     

       89
       +
         - feasible

     

       90
       +
         - finalize

     

       91
       +
         - first and foremost

     

       92
       +
         - for all intents and purposes

     

       93
       +
         - for the most part

     

       94
       +
         - for the purpose of

     

       95
       +
         - forfeit

     

       96
       +
         - formulate

     

       97
       +
         - have a tendency to

     

       98
       +
         - honest truth

     

       99
       +
         - however

     

       100
       +
         - if and when

     

       101
       +
         - impacted

     

       102
       +
         - implement

     

       103
       +
         - in a manner of speaking

     

       104
       +
         - in a timely manner

     

       105
       +
         - in a very real sense

     

       106
       +
         - in accordance with

     

       107
       +
         - in addition

     

       108
       +
         - in all likelihood

     

       109
       +
         - in an effort to

     

       110
       +
         - in between

     

       111
       +
         - in excess of

     

       112
       +
         - in lieu of

     

       113
       +
         - in light of the fact that

     

       114
       +
         - in many cases

     

       115
       +
         - in my opinion

     

       116
       +
         - in order to

     

       117
       +
         - in regard to

     

       118
       +
         - in some instances

     

       119
       +
         - in terms of

     

       120
       +
         - in the case of

     

       121
       +
         - in the event that

     

       122
       +
         - in the final analysis

     

       123
       +
         - in the nature of

     

       124
       +
         - in the near future

     

       125
       +
         - in the process of

     

       126
       +
         - inception

     

       127
       +
         - incumbent upon

     

       128
       +
         - indicate

     

       129
       +
         - indication

     

       130
       +
         - initiate

     

       131
       +
         - irregardless

     

       132
       +
         - is applicable to

     

       133
       +
         - is authorized to

     

       134
       +
         - is responsible for

     

       135
       +
         - it is

     

       136
       +
         - it is essential

     

       137
       +
         - it seems that

     

       138
       +
         - it was

     

       139
       +
         - magnitude

     

       140
       +
         - maximum

     

       141
       +
         - methodology

     

       142
       +
         - minimize

     

       143
       +
         - minimum

     

       144
       +
         - modify

     

       145
       +
         - monitor

     

       146
       +
         - multiple

     

       147
       +
         - necessitate

     

       148
       +
         - nevertheless

     

       149
       +
         - not certain

     

       150
       +
         - not many

     

       151
       +
         - not often

     

       152
       +
         - not unless

     

       153
       +
         - not unlike

     

       154
       +
         - notwithstanding

     

       155
       +
         - null and void

     

       156
       +
         - numerous

     

       157
       +
         - objective

     

       158
       +
         - obligate

     

       159
       +
         - obtain

     

       160
       +
         - on the contrary

     

       161
       +
         - on the other hand

     

       162
       +
         - one particular

     

       163
       +
         - optimum

     

       164
       +
         - overall

     

       165
       +
         - owing to the fact that

     

       166
       +
         - participate

     

       167
       +
         - particulars

     

       168
       +
         - pass away

     

       169
       +
         - pertaining to

     

       170
       +
         - point in time

     

       171
       +
         - portion

     

       172
       +
         - possess

     

       173
       +
         - preclude

     

       174
       +
         - previously

     

       175
       +
         - prior to

     

       176
       +
         - prioritize

     

       177
       +
         - procure

     

       178
       +
         - proficiency

     

       179
       +
         - provided that

     

       180
       +
         - purchase

     

       181
       +
         - put simply

     

       182
       +
         - readily apparent

     

       183
       +
         - refer back

     

       184
       +
         - regarding

     

       185
       +
         - relocate

     

       186
       +
         - remainder

     

       187
       +
         - remuneration

     

       188
       +
         - requirement

     

       189
       +
         - reside

     

       190
       +
         - residence

     

       191
       +
         - retain

     

       192
       +
         - satisfy

     

       193
       +
         - shall

     

       194
       +
         - should you wish

     

       195
       +
         - similar to

     

       196
       +
         - solicit

     

       197
       +
         - span across

     

       198
       +
         - strategize

     

       199
       +
         - subsequent

     

       200
       +
         - substantial

     

       201
       +
         - successfully complete

     

       202
       +
         - sufficient

     

       203
       +
         - terminate

     

       204
       +
         - the month of

     

       205
       +
         - the point I am trying to make

     

       206
       +
         - therefore

     

       207
       +
         - time period

     

       208
       +
         - took advantage of

     

       209
       +
         - transmit

     

       210
       +
         - transpire

     

       211
       +
         - type of

     

       212
       +
         - until such time as

     

       213
       +
         - utilization

     

       214
       +
         - utilize

     

       215
       +
         - validate

     

       216
       +
         - various different

     

       217
       +
         - what I mean to say is

     

       218
       +
         - whether or not

     

       219
       +
         - with respect to

     

       220
       +
         - with the exception of

     

       221
       +
         - witnessed

+207

styles/write-good/Weasel.yml

···

       1
       +
       extends: existence

     

       2
       +
       message: "'%s' is a weasel word!"

     

       3
       +
       ignorecase: true

     

       4
       +
       level: warning

     

       5
       +
       tokens:

     

       6
       +
         - absolutely

     

       7
       +
         - accidentally

     

       8
       +
         - additionally

     

       9
       +
         - allegedly

     

       10
       +
         - alternatively

     

       11
       +
         - angrily

     

       12
       +
         - anxiously

     

       13
       +
         - approximately

     

       14
       +
         - awkwardly

     

       15
       +
         - badly

     

       16
       +
         - barely

     

       17
       +
         - beautifully

     

       18
       +
         - blindly

     

       19
       +
         - boldly

     

       20
       +
         - bravely

     

       21
       +
         - brightly

     

       22
       +
         - briskly

     

       23
       +
         - bristly

     

       24
       +
         - bubbly

     

       25
       +
         - busily

     

       26
       +
         - calmly

     

       27
       +
         - carefully

     

       28
       +
         - carelessly

     

       29
       +
         - cautiously

     

       30
       +
         - cheerfully

     

       31
       +
         - clearly

     

       32
       +
         - closely

     

       33
       +
         - coldly

     

       34
       +
         - completely

     

       35
       +
         - consequently

     

       36
       +
         - correctly

     

       37
       +
         - courageously

     

       38
       +
         - crinkly

     

       39
       +
         - cruelly

     

       40
       +
         - crumbly

     

       41
       +
         - cuddly

     

       42
       +
         - currently

     

       43
       +
         - daily

     

       44
       +
         - daringly

     

       45
       +
         - deadly

     

       46
       +
         - definitely

     

       47
       +
         - deliberately

     

       48
       +
         - doubtfully

     

       49
       +
         - dumbly

     

       50
       +
         - eagerly

     

       51
       +
         - early

     

       52
       +
         - easily

     

       53
       +
         - elegantly

     

       54
       +
         - enormously

     

       55
       +
         - enthusiastically

     

       56
       +
         - equally

     

       57
       +
         - especially

     

       58
       +
         - eventually

     

       59
       +
         - exactly

     

       60
       +
         - exceedingly

     

       61
       +
         - exclusively

     

       62
       +
         - extremely

     

       63
       +
         - fairly

     

       64
       +
         - faithfully

     

       65
       +
         - fatally

     

       66
       +
         - fiercely

     

       67
       +
         - finally

     

       68
       +
         - fondly

     

       69
       +
         - few

     

       70
       +
         - foolishly

     

       71
       +
         - fortunately

     

       72
       +
         - frankly

     

       73
       +
         - frantically

     

       74
       +
         - generously

     

       75
       +
         - gently

     

       76
       +
         - giggly

     

       77
       +
         - gladly

     

       78
       +
         - gracefully

     

       79
       +
         - greedily

     

       80
       +
         - happily

     

       81
       +
         - hardly

     

       82
       +
         - hastily

     

       83
       +
         - healthily

     

       84
       +
         - heartily

     

       85
       +
         - helpfully

     

       86
       +
         - honestly

     

       87
       +
         - hourly

     

       88
       +
         - hungrily

     

       89
       +
         - hurriedly

     

       90
       +
         - immediately

     

       91
       +
         - impatiently

     

       92
       +
         - inadequately

     

       93
       +
         - ingeniously

     

       94
       +
         - innocently

     

       95
       +
         - inquisitively

     

       96
       +
         - interestingly

     

       97
       +
         - irritably

     

       98
       +
         - jiggly

     

       99
       +
         - joyously

     

       100
       +
         - justly

     

       101
       +
         - kindly

     

       102
       +
         - largely

     

       103
       +
         - lately

     

       104
       +
         - lazily

     

       105
       +
         - likely

     

       106
       +
         - literally

     

       107
       +
         - lonely

     

       108
       +
         - loosely

     

       109
       +
         - loudly

     

       110
       +
         - loudly

     

       111
       +
         - luckily

     

       112
       +
         - madly

     

       113
       +
         - many

     

       114
       +
         - mentally

     

       115
       +
         - mildly

     

       116
       +
         - monthly

     

       117
       +
         - mortally

     

       118
       +
         - mostly

     

       119
       +
         - mysteriously

     

       120
       +
         - neatly

     

       121
       +
         - nervously

     

       122
       +
         - nightly

     

       123
       +
         - noisily

     

       124
       +
         - normally

     

       125
       +
         - obediently

     

       126
       +
         - occasionally

     

       127
       +
         - only

     

       128
       +
         - openly

     

       129
       +
         - painfully

     

       130
       +
         - particularly

     

       131
       +
         - patiently

     

       132
       +
         - perfectly

     

       133
       +
         - politely

     

       134
       +
         - poorly

     

       135
       +
         - powerfully

     

       136
       +
         - presumably

     

       137
       +
         - previously

     

       138
       +
         - promptly

     

       139
       +
         - punctually

     

       140
       +
         - quarterly

     

       141
       +
         - quickly

     

       142
       +
         - quietly

     

       143
       +
         - rapidly

     

       144
       +
         - rarely

     

       145
       +
         - really

     

       146
       +
         - recently

     

       147
       +
         - recklessly

     

       148
       +
         - regularly

     

       149
       +
         - remarkably

     

       150
       +
         - relatively

     

       151
       +
         - reluctantly

     

       152
       +
         - repeatedly

     

       153
       +
         - rightfully

     

       154
       +
         - roughly

     

       155
       +
         - rudely

     

       156
       +
         - sadly

     

       157
       +
         - safely

     

       158
       +
         - selfishly

     

       159
       +
         - sensibly

     

       160
       +
         - seriously

     

       161
       +
         - sharply

     

       162
       +
         - shortly

     

       163
       +
         - shyly

     

       164
       +
         - significantly

     

       165
       +
         - silently

     

       166
       +
         - simply

     

       167
       +
         - sleepily

     

       168
       +
         - slowly

     

       169
       +
         - smartly

     

       170
       +
         - smelly

     

       171
       +
         - smoothly

     

       172
       +
         - softly

     

       173
       +
         - solemnly

     

       174
       +
         - sparkly

     

       175
       +
         - speedily

     

       176
       +
         - stealthily

     

       177
       +
         - sternly

     

       178
       +
         - stupidly

     

       179
       +
         - substantially

     

       180
       +
         - successfully

     

       181
       +
         - suddenly

     

       182
       +
         - surprisingly

     

       183
       +
         - suspiciously

     

       184
       +
         - swiftly

     

       185
       +
         - tenderly

     

       186
       +
         - tensely

     

       187
       +
         - thoughtfully

     

       188
       +
         - tightly

     

       189
       +
         - timely

     

       190
       +
         - truthfully

     

       191
       +
         - unexpectedly

     

       192
       +
         - unfortunately

     

       193
       +
         - usually

     

       194
       +
         - very

     

       195
       +
         - victoriously

     

       196
       +
         - violently

     

       197
       +
         - vivaciously

     

       198
       +
         - warmly

     

       199
       +
         - waverly

     

       200
       +
         - weakly

     

       201
       +
         - wearily

     

       202
       +
         - weekly

     

       203
       +
         - wildly

     

       204
       +
         - wisely

     

       205
       +
         - worldly

     

       206
       +
         - wrinkly

     

       207
       +
         - yearly

styles/write-good/meta.json

···

       1
       +
       {

     

       2
       +
         "feed": "https://github.com/errata-ai/write-good/releases.atom",

     

       3
       +
         "vale_version": ">=1.0.0"

     

       4
       +
       }

+10

templates/404.html

···

       1
       +
       {%- extends "index.html" -%}

     

       2
       +
       

     

       3
       +
       {% block og_preview %}

     

       4
       +
       {% endblock og_preview %}

     

       5
       +
       

     

       6
       +
       {% block main %}

     

       7
       +
       <h1>404</h1>

     

       8
       +
       

     

       9
       +
       <p>Page not found</p>

     

       10
       +
       {% endblock main %}

templates/anchor-link.html

···

       0

···

       1
       +
       <a class="zola-anchor" href="#{{ id }}" aria-label="Anchor link for: {{ id }}">#</a>

+40

templates/atom.xml

···

       1
       +
       <?xml version="1.0" encoding="UTF-8"?>

     

       2
       +
       <?xml-stylesheet type="text/xsl" href="/atom-style.xml"?>

     

       3
       +
       <feed xmlns="http://www.w3.org/2005/Atom" xml:lang="{{ lang }}">

     

       4
       +
         <title>{{ config.title }}

     

       5
       +
           {%- if term %} - {{ term.name }}

     

       6
       +
           {%- elif section.title %} - {{ section.title }}

     

       7
       +
           {%- endif -%}

     

       8
       +
         </title>

     

       9
       +
         {%- if config.description %}

     

       10
       +
           <subtitle>{{ config.description }}</subtitle>

     

       11
       +
         {%- endif %}

     

       12
       +
         <link href="{{ feed_url | safe }}" rel="self" type="application/atom+xml"/>

     

       13
       +
         <link href="

     

       14
       +
           {%- if section -%}

     

       15
       +
           {{ section.permalink | escape_xml | safe }}

     

       16
       +
           {%- else -%}

     

       17
       +
           {{ config.base_url | escape_xml | safe }}

     

       18
       +
           {%- endif -%}

     

       19
       +
           " rel="related"/>

     

       20
       +
         <generator uri="https://www.getzola.org/">Zola</generator>

     

       21
       +
         <updated>{{ last_updated | date(format="%+") }}</updated>

     

       22
       +
         <id>{{ feed_url | safe }}</id>

     

       23
       +
         {%- for page in pages %}

     

       24
       +
           <entry xml:lang="{{ page.lang }}">

     

       25
       +
             <title>{{ page.title }}</title>

     

       26
       +
             <published>{{ page.date | date(format="%+") }}</published>

     

       27
       +
             <updated>{{ page.updated | default(value=page.date) | date(format="%+") }}</updated>

     

       28
       +
             <link href="{{ page.permalink | safe }}" type="text/html"/>

     

       29
       +
             <id>{{ page.permalink | safe }}</id>

     

       30
       +
             <summary>

     

       31
       +
             {%- if page.description -%}

     

       32
       +
                 {{ page.description }}

     

       33
       +
             {%- elif page.summary -%}

     

       34
       +
                 {{ page.summary | safe }}

     

       35
       +
             {%- endif -%}

     

       36
       +
             </summary>

     

       37
       +
             <content type="html">{{ page.content }}</content>

     

       38
       +
           </entry>

     

       39
       +
         {%- endfor %}

     

       40
       +
       </feed>

+103 -3

templates/index.html

···

       1
        
       {% extends "zerm/templates/index.html" %}

     

       2
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       3
        
       {% block general_meta %}

     

       4
        
           <meta http-equiv="content-type" content="text/html; charset=utf-8">

     

       5
       -
           <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">

     

       6
       -
           <meta name="description" content="{{ config.description }}"/>

     

       7
       -
           <script async defer data-domain="hauleth.dev" src="https://plausible.io/js/plausible.js"></script>

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       8
        
       {% endblock general_meta %}

···

       1
        
       {% extends "zerm/templates/index.html" %}

     

       2
        
       

     

       3
       +
       {% block fonts %}

     

       4
       +
       {% endblock fonts %}

     

       5
       +
       

     

       6
       +
       {% block rss %}

     

       7
       +
         {%- if config.generate_feed -%}

     

       8
       +
           <link rel="alternate" type="application/atom+xml" title="{{ config.title }} Feed" href="{{ get_url(path="atom.xml", trailing_slash=false) }}">

     

       9
       +
         {%- endif -%}

     

       10
       +
       {% endblock rss %}

     

       11
       +
       

     

       12
       +
       {% block og_preview %}

     

       13
       +
         {%- if section -%}

     

       14
       +
           <link rel="canonical" href="{{ section.permalink }}" />

     

       15
       +
         {%- elif page -%}

     

       16
       +
           <link rel="canonical" href="{{ page.permalink }}" />

     

       17
       +
         {%- else -%}

     

       18
       +
           <link rel="canonical" href="{{ current_url }}" />

     

       19
       +
         {%- endif -%}

     

       20
       +
         {{ social::og_preview() }}

     

       21
       +
       

     

       22
       +
         {%- if config.extra.twitter.site -%}

     

       23
       +
           <meta name="twitter:site" content="{{ config.extra.twitter.site }}" />

     

       24
       +
         {%- endif -%}

     

       25
       +
         {%- if config.extra.twitter.creator -%}

     

       26
       +
           <meta name="twitter:creator" content="{{ config.extra.twitter.creator }}" />

     

       27
       +
         {%- endif -%}

     

       28
       +
       

     

       29
       +
         {%- if config.extra.webmention -%}

     

       30
       +
           <link rel="webmention" href="{{ config.extra.webmention }}" >

     

       31
       +
         {%- endif -%}

     

       32
       +
       {% endblock og_preview %}

     

       33
       +
       

     

       34
       +
       {% block copyright %}

     

       35
       +
         <div class="copyright">

     

       36
       +
           <div class="copyright--user">{{ config.extra.copyright | safe }}</div>

     

       37
       +
           <div class="copyright--tracking">

     

       38
       +
             public tracking available at <a href="https://plausible.io/hauleth.dev">Plausible.io</a>

     

       39
       +
           </div>

     

       40
       +
           <div class="copyright--source">

     

       41
       +
               <a href="{{ config.extra.source }}">source code</a>

     

       42
       +
           </div>

     

       43
       +
         </div>

     

       44
       +
       {% endblock copyright %}

     

       45
       +
       

     

       46
       +
       {% block script %}

     

       47
       +
         <script defer data-domain="hauleth.dev" src="/js/script.js"></script>

     

       48
       +
       {% endblock script %}

     

       49
       +
       

     

       50
       +
       {% block css %}

     

       51
       +
         <link rel="stylesheet" type="text/css" href="/style.css" />

     

       52
       +
         <link rel="stylesheet" type="text/css" href="/syntax-theme.css" />

     

       53
       +
         {% if config.extra.theme_color != "orange" -%}

     

       54
       +
           {% set color = "/color/" ~ config.extra.theme_color ~ ".css" -%}

     

       55
       +
           <link rel="stylesheet" type="text/css" href="{{ color }}" />

     

       56
       +
         {%- else -%}

     

       57
       +
           <link rel="stylesheet" type="text/css" href="/color/orange.css" />

     

       58
       +
         {% endif %}

     

       59
       +
         <meta name="theme-color" content="#1d1e28" />

     

       60
       +
       {% endblock css %}

     

       61
       +
       

     

       62
       +
       {% block header %}

     

       63
       +
         <header class="header">

     

       64
       +
           <div class="header__inner">

     

       65
       +
             <div class="header__logo">

     

       66
       +
               {{ logo::logo() }}

     

       67
       +
             </div>

     

       68
       +
           </div>

     

       69
       +
           <nav class="menu">

     

       70
       +
             <ul class="menu__inner">

     

       71
       +
               {%- for menu_item in config.extra.main_menu -%}

     

       72
       +
               <li>

     

       73
       +
                 <a href="{% if menu_item.url is matching("^https?://") %}{{ menu_item.url }}{% else %}{{ get_url(path=menu_item.url) }}{% endif %}"

     

       74
       +
                    {% if menu_item.rel %}rel="{{ menu_item.rel }}"{% endif %}>{{ menu_item.name }}</a>

     

       75
       +
               </li>

     

       76
       +
               {%- endfor-%}

     

       77
       +
             </ul>

     

       78
       +
           </nav>

     

       79
       +
         </header>

     

       80
       +
       {% endblock header %}

     

       81
       +
       

     

       82
        
       {% block general_meta %}

     

       83
        
           <meta http-equiv="content-type" content="text/html; charset=utf-8">

     

       84
       +
           <meta name="viewport" content="width=device-width, initial-scale=1">

     

       85
       +
           {%- if page.title -%}

     

       86
       +
               <meta name="description" content="{{ config.description }} {{ page.title }} {{ page.description }}"/>

     

       87
       +
           {%- else -%}

     

       88
       +
               <meta name="description" content="{{ config.description }}"/>

     

       89
       +
           {%- endif -%}

     

       90
       +
       

     

       91
       +
           {%- if page.taxonomies.tags or page.taxonomies.categories -%}

     

       92
       +
               <meta name="keywords" content="

     

       93
       +
               {%- if page.taxonomies.categories -%}

     

       94
       +
                   {%- for cat in page.taxonomies.categories -%}

     

       95
       +
                           {{ cat }}, {% endfor -%}

     

       96
       +
               {%- endif -%}

     

       97
       +
       

     

       98
       +
               {%- if page.taxonomies.tags -%}

     

       99
       +
                   {%- for tag in page.taxonomies.tags -%}

     

       100
       +
                       {%- if loop.last -%}

     

       101
       +
                           {{ tag }}

     

       102
       +
                       {%- else -%}

     

       103
       +
                           {{ tag }}, {% endif -%}

     

       104
       +
                   {%- endfor -%}

     

       105
       +
               {%- endif -%}

     

       106
       +
               " />

     

       107
       +
           {%- endif -%}

     

       108
        
       {% endblock general_meta %}

+14

templates/landing.html

···

       1
       +
       {% extends "index.html" -%}

     

       2
       +
       

     

       3
       +
       {%- block main -%}

     

       4
       +
         <section>

     

       5
       +
           <article>

     

       6
       +
             {{ section.content | safe }}

     

       7
       +
           </article>

     

       8
       +
         </section>

     

       9
       +
       

     

       10
       +
         <div>

     

       11
       +
           <h2>blog</h2>

     

       12
       +
           {{ lists::list_pages() }}

     

       13
       +
         </div>

     

       14
       +
       {%- endblock main -%}

+16

templates/macros/extended_footer.html

···

       1
       +
       {% macro extended_footer() %}

     

       2
       +
         <div class="rings">

     

       3
       +
           <details>

     

       4
       +
             <summary>Webrings</summary>

     

       5
       +
             <ul>

     

       6
       +
               {%- for ring in config.extra.webrings -%}

     

       7
       +
               <li>

     

       8
       +
                 <a href="{{ ring.url }}/prev?referrer={{ get_url(path = "/") | safe }}">&laquo;</a>

     

       9
       +
                 <a href="{{ ring.url }}">{{ ring.name }}</a>

     

       10
       +
                 <a href="{{ ring.url }}/next?referrer={{ get_url(path = "/") | safe }}">&raquo;</a>

     

       11
       +
               </li>

     

       12
       +
               {%- endfor -%}

     

       13
       +
             </ul>

     

       14
       +
           </details>

     

       15
       +
         </div>

     

       16
       +
       {% endmacro extended_footer %}

+32

templates/macros/lists.html

···

       1
       +
       {% macro list_pages() %}

     

       2
       +
       <section class="posts">

     

       3
       +
       

     

       4
       +
           {%- for page in paginator.pages -%}

     

       5
       +
       

     

       6
       +
           <div class="post on-list">

     

       7
       +
               <h3 class="post-title">

     

       8
       +
                   <a href="{{ page.permalink }}">{{ page.title }}</a>

     

       9
       +
               </h3>

     

       10
       +
       

     

       11
       +
               {{ posts::meta(page=page, author=config.extra.show_author) }}

     

       12
       +
       

     

       13
       +
               <div class="post-content">

     

       14
       +
                   {%  if page.description -%}

     

       15
       +
                   {{ page.description }}

     

       16
       +
                   {#- end if-check for description -#}

     

       17
       +
                   {%  elif page.summary -%}

     

       18
       +
                   {{ page.summary | safe }}

     

       19
       +
                   {%  endif -%}

     

       20
       +
               </div>

     

       21
       +
               {% if page.description or page.summary -%}

     

       22
       +
               <div>

     

       23
       +
                   <a class="read-more button" href="{{ page.permalink }}">{{ config.extra.read_more }} →</a>

     

       24
       +
               </div>

     

       25
       +
               {% endif -%}

     

       26
       +
           </div>

     

       27
       +
           {# End of pagination for-loop #}

     

       28
       +
           {%- endfor -%}

     

       29
       +
           {#- I don't put pagination here like Terminal does. I don't like how

     

       30
       +
           the buttons move with the size of post entries in the content div. -#}

     

       31
       +
       </section>

     

       32
       +
       {% endmacro list_pages %}

+69

templates/macros/posts.html

···

       1
       +
       {% macro section_meta(section, author) %}

     

       2
       +
           <div class="post-meta">

     

       3
       +
               {%- if section.extra["date"] -%}

     

       4
       +
                 <time class="post-date" datetime="{{ section.extra["date"] }}">

     

       5
       +
                   {{ section.extra["date"] | date(format="%Y.%m.%d") }}

     

       6
       +
                 </time>

     

       7
       +
               {%- endif -%}

     

       8
       +
           </div>

     

       9
       +
       {% endmacro section_meta %}

     

       10
       +
       

     

       11
       +
       {% macro meta(page, author) %}

     

       12
       +
           <div class="post-meta">

     

       13
       +
               <span class="post-date">

     

       14
       +
                   {%- if page.date -%}

     

       15
       +
                     <time class="dt-published" datetime="{{ page.date }}">{{ page.date | date(format="%Y.%m.%d") }}</time>

     

       16
       +
                   {%- endif -%}

     

       17
       +
       

     

       18
       +
                   {%- if page.updated -%}

     

       19
       +
                     [Updated: <time class="dt-updated" datetime="{{ page.updated }}">{{ page.updated | date(format="%Y.%m.%d") }}</time>]

     

       20
       +
                   {%- endif -%}

     

       21
       +
               </span>

     

       22
       +
               ::

     

       23
       +
               <time datetime="P{{ page.reading_time }}M">{{ page.reading_time }} min</time>

     

       24
       +
       

     

       25
       +
               {{ posts::taxonomies(taxonomy=page.taxonomies,

     

       26
       +
                  disp_cat=config.extra.show_categories,

     

       27
       +
                  disp_tag=config.extra.show_tags) }}

     

       28
       +
           </div>

     

       29
       +
       {% endmacro meta %}

     

       30
       +
       

     

       31
       +
       {% macro taxonomies(taxonomy, disp_cat, disp_tag) %}

     

       32
       +
           {%- if taxonomy.categories -%}

     

       33
       +
               {{ posts::categories(categories=taxonomy.categories) }}

     

       34
       +
           {%- endif -%}

     

       35
       +
           {%- if taxonomy.tags -%}

     

       36
       +
               {{ posts::tags(tags=taxonomy.tags) }}

     

       37
       +
           {%- endif -%}

     

       38
       +
       {% endmacro taxonomies %}

     

       39
       +
       

     

       40
       +
       {% macro categories(categories) %}

     

       41
       +
           :: {

     

       42
       +
           {%- for cat in categories -%}

     

       43
       +
               {%- if loop.last -%}

     

       44
       +
                   <a class="p-category" href="{{ get_taxonomy_url(kind="categories", name=cat ) }}">{{ cat }}</a>

     

       45
       +
               {%- else -%}

     

       46
       +
                   <a class="p-category" href="{{ get_taxonomy_url(kind="categories", name=cat ) }}">{{ cat }}</a>,

     

       47
       +
               {%- endif -%}

     

       48
       +
           {%- endfor -%}}{# <--- NOTE: OPEN CURLY BRACE #}

     

       49
       +
       {% endmacro categories %}

     

       50
       +
       

     

       51
       +
       {% macro tags(tags) %}

     

       52
       +
           ::

     

       53
       +
           {% for tag in tags -%}

     

       54
       +
               #<a class="p-category" href="{{get_taxonomy_url(kind="tags", name=tag )}}">{{ tag }}</a>

     

       55
       +
           {% endfor -%}

     

       56
       +
       {% endmacro tags %}

     

       57
       +
       

     

       58
       +
       {% macro thanks(who) %}

     

       59
       +
         {%- if who is object -%}

     

       60
       +
           {%- if who.url -%}

     

       61
       +
             <a class="u-url p-name" href="{{ who.url }}">{{ who.name }}</a>

     

       62
       +
           {%- else -%}

     

       63
       +
             <span class="p-name">{{ who.name }}</span>

     

       64
       +
           {%- endif -%}

     

       65
       +
           {%- if who.why %} for {{ who.why }}{%- endif -%}

     

       66
       +
         {%- else -%}

     

       67
       +
           <span class="p-name">{{ who }}</span>

     

       68
       +
         {%- endif -%}

     

       69
       +
       {% endmacro %}

+11

templates/macros/toc.html

···

       1
       +
       {% macro toc(headers) %}

     

       2
       +
         <ol start="0">

     

       3
       +
         {%- for header in headers -%}

     

       4
       +
           <li><a href="{{ header.permalink }}">{{ header.title }}</a>

     

       5
       +
             {%- if header.children | length > 0 -%}

     

       6
       +
             {{ self::toc(headers=header.children) }}

     

       7
       +
             {%- endif -%}

     

       8
       +
           </li>

     

       9
       +
         {%- endfor -%}

     

       10
       +
         </ol>

     

       11
       +
       {% endmacro toc %}

+78

templates/page.html

···

       1
       +
       {%- extends "index.html" -%}

     

       2
       +
       

     

       3
       +
       {%- import "macros/toc.html" as toc -%}

     

       4
       +
       

     

       5
       +
       {%- block title -%}

     

       6
       +
         <title>{{ page.title }} - {{  config.extra.author }}</title>

     

       7
       +
       {%- endblock title -%}

     

       8
       +
       

     

       9
       +
       {%- block main -%}

     

       10
       +
         <article class="post h-entry">

     

       11
       +
           <h1 class="post-title p-name">

     

       12
       +
             <a id="top" href="{{ page.permalink }}">{{ page.title }}</a>

     

       13
       +
           </h1>

     

       14
       +
           {{ posts::meta(page=page, author=config.extra.show_author) }}

     

       15
       +
           {%- if page.toc | length >= 5 -%}

     

       16
       +
           <div class="post-toc">

     

       17
       +
             <label for="toc-toggle">Table of content</label>

     

       18
       +
             <input type="checkbox" id="toc-toggle" hidden />

     

       19
       +
             <div class="toggleable">

     

       20
       +
               {{ toc::toc(headers=page.toc) }}

     

       21
       +
             </div>

     

       22
       +
           </div>

     

       23
       +
           {%- endif -%}

     

       24
       +
           <div class="post-content e-content">

     

       25
       +
             {{ page.content | safe }}

     

       26
       +
             <div class="halmos">&#x220e;</div>

     

       27
       +
           </div>

     

       28
       +
           {%- if config.extra.for_hire -%}

     

       29
       +
           <div class="for-hire">

     

       30
       +
             <p>Author of this post is currently open for hire (<a href="/cv">CV</a>).<p>

     

       31
       +
             <p>You can contact me at <a href="lukasz@niemier.pl">lukasz@niemier.pl</a></p>

     

       32
       +
           </div>

     

       33
       +
           {%- endif -%}

     

       34
       +
           {%- if page.extra.thanks -%}

     

       35
       +
           <hr />

     

       36
       +
           <p>

     

       37
       +
             <b>Special thanks to</b>:

     

       38
       +
             <ul>

     

       39
       +
               {%- for person in page.extra.thanks -%}

     

       40
       +
               <li class="h-card">{{ posts::thanks(who=person) }}</li>

     

       41
       +
               {%- endfor -%}

     

       42
       +
             </ul>

     

       43
       +
           </p>

     

       44
       +
           {%- endif -%}

     

       45
       +
           {%- if not page.extra.no_comments -%}

     

       46
       +
           <hr />

     

       47
       +
           <div>

     

       48
       +
             <p>You can provide feedback via mailing list

     

       49
       +
               <a href="mailto:~hauleth/blog@lists.sr.ht?subject=[Comment] {{

     

       50
       +
                 page.title }}">~hauleth/blog@lists.sr.ht</a>

     

       51
       +
                 (<a href="https://lists.sr.ht/~hauleth/blog">archive</a>).</p>

     

       52
       +
           </div>

     

       53
       +
       

     

       54
       +
           <div class="webmentions">

     

       55
       +
             {%- set webmentions = load_data(url="https://webmention.io/api/mentions.jf2?target=" ~ page.permalink, format="json") -%}

     

       56
       +
             {%- if webmentions.children | length > 0 -%}

     

       57
       +
               <p>Webmentions:</p>

     

       58
       +
               <ul>

     

       59
       +
                 {%- for mention in webmentions.children -%}

     

       60
       +
                 <li>

     

       61
       +
                   {%- if mention.name -%}

     

       62
       +
                     <a href="{{ mention.url }}">{{ mention.name }}</a>

     

       63
       +
                     {%- else -%}

     

       64
       +
                     <a href="{{ mention.url }}" class="url-only">{{ mention.url }}</a>

     

       65
       +
                   {%- endif -%}

     

       66
       +
                   {% if mention.author.name != "" %}

     

       67
       +
                     by&nbsp;<a href="{{ mention.author.url }}">{{ mention.author.name | truncate(length=15) }}</a>

     

       68
       +
                   {%- endif -%}

     

       69
       +
                 </li>

     

       70
       +
                 {%- endfor -%}

     

       71
       +
               </ul>

     

       72
       +
             {%- else -%}

     

       73
       +
               No webmentions yet, you can be first.

     

       74
       +
             {%- endif -%}

     

       75
       +
           </div>

     

       76
       +
           {%- endif -%}

     

       77
       +
         </article>

     

       78
       +
       {%- endblock main -%}

templates/robots.txt

···

       1
       +
       User-agent: *

     

       2
       +
       Disallow: /cv/ /404/ /common-test-example/

     

       3
       +
       Allow: /

     

       4
       +
       Sitemap: {{ get_url(path="sitemap.xml") }}

+186

templates/shortcodes/cv.md

···

       1
       +
       # Łukasz Jan Niemier

     

       2
       +
       

     

       3
       +
       ## Personal information

     

       4
       +
       

     

       5
       +
       Email:

     

       6
       +
         <~@hauleth.dev>

     

       7
       +
       

     

       8
       +
       Website:

     

       9
       +
         <https://hauleth.dev>

     

       10
       +
       

     

       11
       +
       Twitter:

     

       12
       +
         [@hauleth](https://twitter.com/hauleth)

     

       13
       +
       

     

       14
       +
       ## Education

     

       15
       +
       

     

       16
       +
       - Poznań University of Technology: Computer Science - no degree - 2012-2015

     

       17
       +
           + Secretary of AKAI - Students' Association of Web Developers

     

       18
       +
       

     

       19
       +
       ## Experience

     

       20
       +
       

     

       21
       +
       - Hauleth.dev - Consultant - 2021+

     

       22
       +
           + DockYard/Karambit.ai - 2025

     

       23
       +
               * Architectural analysis of Karambit product

     

       24
       +
               * Prepared security analysis with detailed report with fixes

     

       25
       +
           + Eiger - 2022-2023

     

       26
       +
               * Forte.io

     

       27
       +
                   - Implemented Interledger protocol for cross-chain transactions

     

       28
       +
               * Aleo Blockchain

     

       29
       +
                   - Implemented GraphQL API for the on-chain data

     

       30
       +
                   - Created syntax colouring library for Aleo assembly-like language

     

       31
       +
                     for smart contracts

     

       32
       +
           + Erlang Solutions/Kloeckner GmbH - 2021 - Consultant for Elixir, Ruby,

     

       33
       +
             and SQL (PostgreSQL)

     

       34
       +
               * Optimised DB query performance by providing PostgreSQL structure

     

       35
       +
                 analysis and improving indices usage

     

       36
       +
           + Remote Inc. - Senior Backend Engineer - 2020-2021

     

       37
       +
               * Architectural analysis of existing codebase

     

       38
       +
           + Kobil GmbH - Erlang/Elixir Developer - 2019-2020

     

       39
       +
               * Maintained MongoDB driver for Elixir

     

       40
       +
               * Implemented transactions for MongoDB driver in Elixir

     

       41
       +
       - Supabase - 2023-2025

     

       42
       +
           + Logflare - logs aggregation service:

     

       43
       +
               * Implemented on-the-fly decompression of incoming data that improved

     

       44
       +
                 ingestion possibilities and reduced transfer usage (created library

     

       45
       +
                 [`plug_caisson`][] for that purpose)

     

       46
       +
               * Implemented DataDog-compatible ingestion endpoint for seamless

     

       47
       +
                 transition from DataDog provider to Logflare

     

       48
       +
               * Improved BigQuery pipeline workflow to reduce congestion on database

     

       49
       +
                 connections

     

       50
       +
               * Added support for AWS Cloud Events metadata extraction

     

       51
       +
               * Improved CI usage by splitting different actions to separate steps ran

     

       52
       +
                 in parallel

     

       53
       +
               * Replaced dynamic generation of connection modules for PostgreSQL

     

       54
       +
                 storage system with Ecto's dynamic repositories to avoid atom exhaustion

     

       55
       +
           + Supavisor - a cloud-native, multi-tenant Postgres connection pooler

     

       56
       +
               * Deployment management

     

       57
       +
               * Optimised metrics gathering system that resulted in an order of

     

       58
       +
                 magnitude performance boost

     

       59
       +
               * Updated used OTP and Elixir versions from OTP 24 to OTP 27 and Elixir

     

       60
       +
                 from 1.14 to 1.18

     

       61
       +
               * Reduced usage of mocking in tests to improve tests performance and

     

       62
       +
                 volatility, resulting in reduced CI usage and improved developer

     

       63
       +
                 experience

     

       64
       +
               * Implemented e2e tests against existing Node.js PostgreSQL clients to

     

       65
       +
                 improve production issues

     

       66
       +
               * Implemented multi-region deployment system to provide blue/green

     

       67
       +
                 deployments

     

       68
       +
               * Improved system observability features by making it more resilient and

     

       69
       +
                 performant

     

       70
       +
               * Replaced usage of `ct_slave` with newer `peer` module in OTP

     

       71
       +
       - AppUnite - Full-stack Developer/DevOps - 2016-2019:

     

       72
       +
           + JaFolders/AlleFolders

     

       73
       +
               * 2x performance improvement by optimising PostgreSQL usage

     

       74
       +
               * Reduced geo-queries using PostGIS thanks to better indices and

     

       75
       +
                 materialised views usage

     

       76
       +
               * Implemented UI and brochure viewer in Vue and SVG

     

       77
       +
           + OneMedical/Helium Health

     

       78
       +
               * Architectural redesign of application from Rails/MongoDB to

     

       79
       +
                 Phoenix/PostgreSQL

     

       80
       +
               * Prepared hybrid deployment with on-premise/in-cloud system

     

       81
       +
               * Migrated of the existing deployments from MongoDB to PostgreSQL

     

       82
       +
       - Nukomeet - Full-stack Developer - 2015-2016

     

       83
       +
       - Prograils - Junior Developer - 2013

     

       84
       +
       

     

       85
       +
       ### Organisations

     

       86
       +
       

     

       87
       +
       - Erlang Ecosystem Foundation - member of the Observability WG

     

       88
       +
       - OpenTelemetry Project - member of the Erlang WG

     

       89
       +
       

     

       90
       +
       ### Other fields

     

       91
       +
       

     

       92
       +
       - Volunteer:

     

       93
       +
           + Pyrkon Fan Convention

     

       94
       +
               * Helper - 2011, 2012, 2013, 2014, 2016

     

       95
       +
               * Organizer - 2015

     

       96
       +
           + UEFA Championship 2012 - Poland-Ukraine

     

       97
       +
               * ICT Accreditation support

     

       98
       +
       - Times Person of the Year - 2006

     

       99
       +
       

     

       100
       +
       ### Languages

     

       101
       +
       

     

       102
       +
       - Polish - mother tongue

     

       103
       +
       - English - fluent

     

       104
       +
       

     

       105
       +
       ### Showcase

     

       106
       +
       

     

       107
       +
       - GitHub: <https://github.com/hauleth>

     

       108
       +
       - GitLab: <https://gitlab.com/hauleth>

     

       109
       +
       - SourceHut: <https://sr.ht/~hauleth>

     

       110
       +
       - StackOverflow: <https://stackoverflow.com/u/1017941>

     

       111
       +
       

     

       112
       +
       ### Notable contributions

     

       113
       +
       

     

       114
       +
       - Elixir language:

     

       115
       +
           + Logger reimplementation on top of Erlang's `logger` module

     

       116
       +
           + `mix test --cover` CLI output

     

       117
       +
           + Support for `NO_COLOR` environment variable

     

       118
       +
           + `is_struct/1`

     

       119
       +
           + Fixing module inspection on case-insensitive file systems

     

       120
       +
           + Support for parsing extra arguments via `mix eval` and `eval` command in

     

       121
       +
             release

     

       122
       +
       - Erlang OTP:

     

       123
       +
           + Support for custom devices in `logger_std_h`

     

       124
       +
           + Fixing `socket` module to support broader set of protocols (for example

     

       125
       +
             ICMP)

     

       126
       +
           + Support for global metadata in `logger`

     

       127
       +
           + Support for reconfiguration of `logger` (needed for better Mix and Rebar3

     

       128
       +
             integration)

     

       129
       +
           + Several fixes to `logger` and `socket` modules

     

       130
       +
           + Add support for τ constant in `math`

     

       131
       +
       - Git:

     

       132
       +
           + Add support for Elixir in diff

     

       133
       +
       - Ecto:

     

       134
       +
           + Support aggregations over `*`

     

       135
       +
           + Better error on duplicated `schema` block

     

       136
       +
       - Elixir MongoDB driver

     

       137
       +
           + Support for transactions

     

       138
       +
       

     

       139
       +
       ### Notable projects

     

       140
       +
       

     

       141
       +
       - <https://github.com/hauleth/erlang-systemd> - systemd integration for Erlang

     

       142
       +
         projects

     

       143
       +
       - <https://github.com/hauleth/mix_unused> - Mix compiler for detecting unused

     

       144
       +
         code

     

       145
       +
       - <https://github.com/open-telemetry/opentelemetry-erlang> - maintainer of

     

       146
       +
         the Erlang's OpenTelemetry implementation

     

       147
       +
       - Vim plugins:

     

       148
       +
           + <https://github.com/hauleth/asyncdo.vim> - simple asynchronous task runner

     

       149
       +
           + <https://github.com/hauleth/sad.vim> - search and replace text - faster

     

       150
       +
           + <https://gitlab.com/hauleth/qfx.vim> - display signs next to QF matches

     

       151
       +
       

     

       152
       +
       ### Languages and Frameworks

     

       153
       +
       

     

       154
       +
       - Elixir

     

       155
       +
           + Phoenix

     

       156
       +
           + Ecto

     

       157
       +
       - Erlang

     

       158
       +
           + OpenTelemetry collaborator

     

       159
       +
           + EEF Member

     

       160
       +
           + OTP contributor

     

       161
       +
       - Nix/NixOS

     

       162
       +
       - Rust

     

       163
       +
       - PostgreSQL

     

       164
       +
       - sh/Bash

     

       165
       +
       - Ruby

     

       166
       +
           + Ruby on Rails

     

       167
       +
       

     

       168
       +
       ### Technologies

     

       169
       +
       

     

       170
       +
       - Git

     

       171
       +
       - Vim

     

       172
       +
       - HashiStack

     

       173
       +
           + Terraform

     

       174
       +
           + Consul

     

       175
       +
           + Nomad

     

       176
       +
       - GNU/Linux and other UNIX-like systems

     

       177
       +
       - TDD/BDD methodologies

     

       178
       +
       - Property testing

     

       179
       +
       

     

       180
       +
       ## Other

     

       181
       +
       

     

       182
       +
       - Viking reenactor

     

       183
       +
       - Keyboard fan

     

       184
       +
       - Sci-fi/Fantasy fan and Poznań's Sci-fi/Fantasy club member

     

       185
       +
       

     

       186
       +
       [`plug_caisson`]: https://github.com/supabase/plug_caisson

+17

templates/shortcodes/readme.md

···

       1
       +
       # hello

     

       2
       +
       

     

       3
       +
       <div class="h-card">

     

       4
       +
       

     

       5
       +
       My name is <span class="p-name">Łukasz Niemier</span>, but I am mostly using

     

       6
       +
       <span class="p-nickname">Hauleth</span> over the internet.

     

       7
       +
       

     

       8
       +
       I am part of the <span class="h-card"><a class="p-name p-org u-url"

     

       9
       +
       href="https://erlef.org/wg/observability">Erlang Ecosystem Foundation

     

       10
       +
       Observability WG</a></span> where we are trying to improve observability

     

       11
       +
       features in Erlang ecosystem.

     

       12
       +
       

     

       13
       +
       I am open for hire. If you want to inquiry me about my services then

     

       14
       +
       contact me at <a class="u-email"

     

       15
       +
       href="mailto:lukasz@niemier.pl">lukasz@niemier.pl</a>.

     

       16
       +
       

     

       17
       +
       </div>

+13

templates/sitemap.xml

···

       1
       +
       <?xml version="1.0" encoding="UTF-8"?>

     

       2
       +
       <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">

     

       3
       +
           {%- for sitemap_entry in entries %}

     

       4
       +
           {%- if sitemap_entry.extra | get(key="sitemap", default=true) %}

     

       5
       +
           <url>

     

       6
       +
               <loc>{{ sitemap_entry.permalink | escape_xml | safe }}</loc>

     

       7
       +
               {%- if sitemap_entry.updated %}

     

       8
       +
               <lastmod>{{ sitemap_entry.updated }}</lastmod>

     

       9
       +
               {%- endif %}

     

       10
       +
           </url>

     

       11
       +
           {%- endif %}

     

       12
       +
           {%- endfor %}

     

       13
       +
       </urlset>

themes/zerm/.gitignore

···

       0

···

       1
       +
       public

+22

themes/zerm/LICENSE.md

···

       1
       +
       The MIT License (MIT)

     

       2
       +
       

     

       3
       +
       Copyright (c) 2019 elias julian marko garcia

     

       4
       +
       Copyright (c) 2019 Paweł Romanowski

     

       5
       +
       Copyright (c) 2019 panr

     

       6
       +
       

     

       7
       +
       Permission is hereby granted, free of charge, to any person obtaining a copy of

     

       8
       +
       this software and associated documentation files (the "Software"), to deal in

     

       9
       +
       the Software without restriction, including without limitation the rights to

     

       10
       +
       use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

     

       11
       +
       the Software, and to permit persons to whom the Software is furnished to do so,

     

       12
       +
       subject to the following conditions:

     

       13
       +
       

     

       14
       +
       The above copyright notice and this permission notice shall be included in all

     

       15
       +
       copies or substantial portions of the Software.

     

       16
       +
       

     

       17
       +
       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

     

       18
       +
       IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

     

       19
       +
       FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

     

       20
       +
       COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

     

       21
       +
       IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

     

       22
       +
       CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+61

themes/zerm/README.md

···

       1
       +
       # zerm

     

       2
       +
       

     

       3
       +
       a minimalist and dark theme for [Zola](https://getzola.org).

     

       4
       +
       

     

       5
       +
       ![Screenshot](../master/zerm-preview.png?raw=true)

     

       6
       +
       

     

       7
       +
       [**Live Preview!**](https://zerm.ejmg.now.sh/)

     

       8
       +
       

     

       9
       +
       Largely a port of Radek Kozieł's [Terminal

     

       10
       +
       Theme](https://github.com/panr/hugo-theme-terminal) for Hugo. 4/5ths of my way

     

       11
       +
       through porting this theme, I discovered Paweł Romanowski own independent fork

     

       12
       +
       for Zola, [Terminimal](https://github.com/pawroman/zola-theme-terminimal),

     

       13
       +
       which helped me get the PostCSS to Sass styling conversion done more

     

       14
       +
       quickly. My sincerest thanks to both of you!

     

       15
       +
       

     

       16
       +
       ## differences

     

       17
       +
       

     

       18
       +
       This theme is largely true to the original by Radek, but there are some mild

     

       19
       +
       differences. They are almost all stylistic in nature and are intended to

     

       20
       +
       emphasize minimalism even more. Some of them are as follows:

     

       21
       +
       - tags are now included in a post's meta data.

     

       22
       +
       - no post image previews.

     

       23
       +
       - categories are included in the taxonomy.

     

       24
       +
       - bullet points have slightly more margin and different symbols for nesting.

     

       25
       +
       - no social media or comment support.

     

       26
       +
       

     

       27
       +
       Some of these might be added later and [PR's are always

     

       28
       +
       welcomed](https://github.com/ejmg/zerm/pulls).

     

       29
       +
       

     

       30
       +
       ## configuration

     

       31
       +
       

     

       32
       +
       Please follow the Zola documentation for [how to use a

     

       33
       +
       theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/#installing-a-theme).

     

       34
       +
       

     

       35
       +
       In `config.toml`, you will find all values for customization that are supported

     

       36
       +
       thus far have documentation explaining how they are used. If there is any confusion or something is not working as intended, [please open an issue](https://github.com/ejmg/zerm/issues)!

     

       37
       +
       

     

       38
       +
       ## math

     

       39
       +
       You can use KaTeX for mathematical typesetting.

     

       40
       +
       Assets are only available if you opt-in on a per-page level through

     

       41
       +
       a single line (`math=true`) on the extra section of the page frontmatter.

     

       42
       +
       

     

       43
       +
       ``` md

     

       44
       +
       # index.md

     

       45
       +
       +++

     

       46
       +
       title="this page title"

     

       47
       +
       ...

     

       48
       +
       

     

       49
       +
       [extra]

     

       50
       +
       math=true

     

       51
       +
       +++

     

       52
       +
       

     

       53
       +
       Content

     

       54
       +
       ```

     

       55
       +
       

     

       56
       +
       Pages wich doesn't opt-in are not affected in any way, so you doesn't have

     

       57
       +
       to worry about any performance hit.

     

       58
       +
       

     

       59
       +
       ## license

     

       60
       +
       

     

       61
       +
       MIT. See `LICENSE.md` for more details.

+131

themes/zerm/config.toml

···

       1
       +
       # The URL the site will be built for

     

       2
       +
       base_url = "/"

     

       3
       +
       

     

       4
       +
       # Used in RSS by default

     

       5
       +
       title = "My blog!"

     

       6
       +
       description = "placeholder description text for your blog!"

     

       7
       +
       

     

       8
       +
       # The default language, used in RSS

     

       9
       +
       # TODO: I would love to support more languages and make this easy to handle

     

       10
       +
       # with other facets of the theme.

     

       11
       +
       default_language = "en"

     

       12
       +
       

     

       13
       +
       # Whether to generate a RSS feed automatically

     

       14
       +
       generate_feed = true

     

       15
       +
       # 'atom.xml' (default if unspecified) and 'rss.xml' are officially supported

     

       16
       +
       # values for feed_filename in this theme. All other filenames will assume a

     

       17
       +
       # link type of 'application/rss+xml'.

     

       18
       +
       # feed_filename = "atom.xml"

     

       19
       +
       

     

       20
       +
       # Theme name to use.

     

       21
       +
       # NOTE: should not need to mess with this if you are using zerm directly, i.e. cloning the

     

       22
       +
       # repository at root and not using as directed by the Zola docs via themes/ directory.

     

       23
       +
       # theme = ""

     

       24
       +
       

     

       25
       +
       # Whether to automatically compile all Sass files in the sass directory

     

       26
       +
       compile_sass = true

     

       27
       +
       

     

       28
       +
       # Whether to do syntax highlighting

     

       29
       +
       # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola

     

       30
       +
       highlight_code = true

     

       31
       +
       

     

       32
       +
       # Syntax highlighting theme. See:

     

       33
       +
       # https://www.getzola.org/documentation/getting-started/configuration/#syntax-highlighting

     

       34
       +
       # for more information and themes built into Zola.

     

       35
       +
       highlight_theme = "axar" # Other dark themes that work: "1337", "agola-dark",

     

       36
       +
                                # "visual-studio-dark"

     

       37
       +
       

     

       38
       +
       # Whether to build a search index to be used later on by a JavaScript library

     

       39
       +
       build_search_index = false

     

       40
       +
       

     

       41
       +
       # Built in taxonomies of zerm.

     

       42
       +
       taxonomies = [

     

       43
       +
                  {name = "tags"},

     

       44
       +
                  {name = "categories"},

     

       45
       +
       ]

     

       46
       +
       

     

       47
       +
       [extra]

     

       48
       +
       # Put all your custom variables here

     

       49
       +
       #

     

       50
       +
       # Many configurations are taken directly from Terminal's config.toml

     

       51
       +
       # ---------------------------------------------------------

     

       52
       +
       

     

       53
       +
       # Author name to be added to posts, if enabled.

     

       54
       +
       author = "you!"

     

       55
       +
       

     

       56
       +
       # Show author's name in blog post meta data.

     

       57
       +
       show_author = false

     

       58
       +
       

     

       59
       +
       # Show categories a blog post is marked with in its meta data.

     

       60
       +
       show_categories = true

     

       61
       +
       

     

       62
       +
       # Show tags a blog post is marked with in its meta data.

     

       63
       +
       show_tags = true

     

       64
       +
       

     

       65
       +
       # Theme color. You can have any color you want, so long as it's...

     

       66
       +
       # ["orange", "blue", "red", "green", "pink"]

     

       67
       +
       theme_color = "orange"

     

       68
       +
       

     

       69
       +
       # Custom css to style over the defaults. This is useful when you only have a

     

       70
       +
       # few small tweaks to make rather than a major rehaul to the theme.

     

       71
       +
       # It would be best to make this a proper .sass or .scss file in sass/ rather

     

       72
       +
       # than placing in static/

     

       73
       +
       # custom_css = "custom.css"

     

       74
       +
       

     

       75
       +
       # How many menu items to show on desktop. if you set this to 0, only submenu

     

       76
       +
       # button will be visible.

     

       77
       +
       show_menu_items = 2

     

       78
       +
       

     

       79
       +
       # set theme to full screen width.

     

       80
       +
       full_width = false

     

       81
       +
       

     

       82
       +
       # center theme with default width.

     

       83
       +
       center = false

     

       84
       +
       

     

       85
       +
       # set a custom favicon. Must be placed in root of static/ directory...

     

       86
       +
       # favicon = ""

     

       87
       +
       

     

       88
       +
       

     

       89
       +
       # Set a custom preview image for your website when posted as a link.

     

       90
       +
       # Must be placed in root of static/ directory...

     

       91
       +
       # og_preview_img = ""

     

       92
       +
       

     

       93
       +
       # Copyright notice if desired. Defaults to

     

       94
       +
       # copyright = "copyright notice here"

     

       95
       +
       

     

       96
       +
       # What is displayed in the top left corner of the website. Default is zerm.

     

       97
       +
       logo_text = "zerm"

     

       98
       +
       

     

       99
       +
       # Link in logo. Default returns you to $BASE_URL.

     

       100
       +
       logo_home_link = "/"

     

       101
       +
       

     

       102
       +
       # Menu items to display. You define a url and the name of the menu item.

     

       103
       +
       # NOTE: `$BASE_URL/` must be included in the url name.

     

       104
       +
       main_menu = [

     

       105
       +
                     {url="/about/", name="about"},

     

       106
       +
                     {url="/contact/", name="contact"},

     

       107
       +
                     {url="https://google.com", name="Google", external=true},

     

       108
       +
       ]

     

       109
       +
       

     

       110
       +
       # Displayed as title of drop-down menu when size of main_menu > show_menu_items.

     

       111
       +
       menu_more = "show more"

     

       112
       +
       

     

       113
       +
       # Displayed after teaser text for a blog post.

     

       114
       +
       read_more = "read more"

     

       115
       +
       

     

       116
       +
       # not currently used from previous theme, but leaving here for now in case I

     

       117
       +
       # feel like adding it.

     

       118
       +
       read_other_posts = "read other posts"

     

       119
       +
       

     

       120
       +
       

     

       121
       +
       # Enable math typesetting with KaTeX

     

       122
       +
       # Show math in pages with `math=true` in the TOML frontmatter

     

       123
       +
       enable_katex = true

     

       124
       +
       

     

       125
       +
       # Options for disqus

     

       126
       +
       disqus = { enabled=false, short_name="" }

     

       127
       +
       

     

       128
       +
       # generate Table of Contents for all articles

     

       129
       +
       # Table of Contents can be generated for individual articles

     

       130
       +
       # by adding `ToC = true` in [extra] section in frontmatter

     

       131
       +
       # ToC = true

themes/zerm/content/_index.md

···

       1
       +
       +++

     

       2
       +
       sort_by = "date"

     

       3
       +
       transparent = true

     

       4
       +
       paginate_by = 3

     

       5
       +
       insert_anchor_links = "right"

     

       6
       +
       +++

+10

themes/zerm/content/about/_index.md

···

       1
       +
       +++

     

       2
       +
       title = "about"

     

       3
       +
       path = "about"

     

       4
       +
       

     

       5
       +
       [extra]

     

       6
       +
       date = 2019-03-21

     

       7
       +
       +++

     

       8
       +
       

     

       9
       +
       Yet another theme for yet another static site generator; that said, I hope you

     

       10
       +
       like it.

+14

themes/zerm/content/contact/_index.md

···

       1
       +
       +++

     

       2
       +
       title="contact"

     

       3
       +
       description="a basic demo of zola. Does it work?"

     

       4
       +
       

     

       5
       +
       [extra]

     

       6
       +
       date=2019-03-26

     

       7
       +
       +++

     

       8
       +
       

     

       9
       +
       # some links

     

       10
       +
       

     

       11
       +
       - [zola, the static site generator written in rust](https://getzola.org)

     

       12
       +
       - [source code for zerm](https://github.com/ejmg/zerm)

     

       13
       +
       - [Terminal, the theme zerm was derived from](https://github.com/panr/hugo-theme-terminal)

     

       14
       +
       - [Terminimal, another theme for zola based on Terminal](https://github.com/pawroman/zola-theme-terminimal)

+65

themes/zerm/content/demo/index.md

···

       1
       +
       +++

     

       2
       +
       title="demo"

     

       3
       +
       description="a basic demo of zola."

     

       4
       +
       date=2019-08-06

     

       5
       +
       

     

       6
       +
       [taxonomies]

     

       7
       +
       tags = ["demo", "zola", "highlighting"]

     

       8
       +
       categories = ["programming", "wu tang",]

     

       9
       +
       

     

       10
       +
       [extra]

     

       11
       +
       +++

     

       12
       +
       

     

       13
       +
       Here's a general demo of Zola and how things look with zerm.

     

       14
       +
       

     

       15
       +
       # Header I

     

       16
       +
       

     

       17
       +
       Inline code: `println!("Wu Tang!");`

     

       18
       +
       

     

       19
       +
       Zola has built in syntax highlighting. If there's not a theme you like, you can

     

       20
       +
       easily add more.

     

       21
       +
       

     

       22
       +
       zerm uses Fira Code fonts, which means we get ligatures in addition to

     

       23
       +
       Zola's powerful syntax highlighting ✨.

     

       24
       +
       

     

       25
       +
       ```rs

     

       26
       +
       fn foo(arg: String) -> Result<u32, Io::Error> {

     

       27
       +
           println!("Nice!"); // TODO: the thingy

     

       28
       +
           if 1 != 0 {

     

       29
       +
               println!("How many ligatures can I contrive??");

     

       30
       +
               println!("Turns out a lot! ==> -/-> <!-- <$> >>=");

     

       31
       +
           }

     

       32
       +
           Ok(42)

     

       33
       +
       }

     

       34
       +
       ```

     

       35
       +
       

     

       36
       +
       ## Header II

     

       37
       +
       

     

       38
       +
       Want block quotes? We got block quotes.

     

       39
       +
       

     

       40
       +
       Remember the wise words of Ras Kass:

     

       41
       +
       

     

       42
       +
       > In Hotel Rwanda, reminder to honor these street scholars who ask why

     

       43
       +
       U.S. Defense is twenty percent of the tax dollar. Bush gave 6.46 billion to

     

       44
       +
       Halliburton for troops support efforts in Iraq; meanwhile, the hood is hurting,

     

       45
       +
       please believe that.

     

       46
       +
       > 

     

       47
       +
       > -- "Verses", _Wu-Tang Meets The Indie Culture_

     

       48
       +
       

     

       49
       +
       ### Header III

     

       50
       +
       

     

       51
       +
       | members          | age | notable album                                | to be messed with?                                                      |

     

       52
       +
       |------------------|-----|----------------------------------------------|-------------------------------------------------------------------------|

     

       53
       +
       | GZA              | 52  | Liquid Swords                                | no                                                                      |

     

       54
       +
       | ODB              | 35  | Return to the 36 Chambers: The Dirty Version | absolutely not                                                          |

     

       55
       +
       | Raekwon Da Chef  | 49  | Only Built 4 Cuban Linx...                   | `"no"`  that's spanish for "no"                                         |

     

       56
       +
       | Ghostface Killah | 49  | Fishscale                                    | i swear you keep asking that question and the answer ain't gonna change |

     

       57
       +
       | Inspectah Deck   | 49  | CZARFACE                                     | `protect ya neck, boy`                                                  |

     

       58
       +
       

     

       59
       +
       

     

       60
       +
       #### Header IV

     

       61
       +
       

     

       62
       +
       Here's a video of my rabbit, Smalls, loaf'n to lofi beats:

     

       63
       +
       

     

       64
       +
       {{ youtube(id="UUpuz8IObcs") }}

     

       65
       +

+13

themes/zerm/content/fiz/index.md

···

       1
       +
       +++

     

       2
       +
       title="fiz"

     

       3
       +
       description="a basic demo of zola. Does it work?"

     

       4
       +
       date=2019-03-25

     

       5
       +
       author="elias"

     

       6
       +
       

     

       7
       +
       [taxonomies]

     

       8
       +
       tags = ["rust", "test"]

     

       9
       +
       # categories = ["misc."]

     

       10
       +
       +++

     

       11
       +
       

     

       12
       +
       

     

       13
       +
       Foo Bar Buzz Fizz Qux Fum

+21

themes/zerm/content/technology_is_hell/index.md

···

       1
       +
       +++

     

       2
       +
       title="technology is hell!"

     

       3
       +
       description="Yet another blog post ranting about XYZ technology for ABC reasons"

     

       4
       +
       date=2019-03-26

     

       5
       +
       

     

       6
       +
       [taxonomies]

     

       7
       +
       tags = ["rust", "test"]

     

       8
       +
       categories = ["misc."]

     

       9
       +
       +++

     

       10
       +
       

     

       11
       +
       

     

       12
       +
       Nullam eu ante vel est convallis dignissim.  Fusce suscipit, wisi nec facilisis

     

       13
       +
       facilisis, est dui fermentum leo, quis tempor ligula erat quis odio.  Nunc

     

       14
       +
       porta vulputate tellus.  Nunc rutrum turpis sed pede.  Sed bibendum.  Aliquam

     

       15
       +
       posuere.  Nunc aliquet, augue nec adipiscing interdum, lacus tellus malesuada

     

       16
       +
       massa, quis varius mi purus non odio.  Pellentesque condimentum, magna ut

     

       17
       +
       suscipit hendrerit, ipsum augue ornare nulla, non luctus diam neque sit amet

     

       18
       +
       urna.  Curabitur vulputate vestibulum lorem.  Fusce sagittis, libero non

     

       19
       +
       molestie mollis, magna orci ultrices dolor, at vulputate neque nulla lacinia

     

       20
       +
       eros.  Sed id ligula quis est convallis tempor.  Curabitur lacinia pulvinar

     

       21
       +
       nibh.  Nam a sapien.

+57

themes/zerm/content/using_katex/index.md

···

       1
       +
       +++

     

       2
       +
       title="Using KaTeX for mathematical typesetting"

     

       3
       +
       date=2021-06-16

     

       4
       +
       

     

       5
       +
       [taxonomies]

     

       6
       +
       categories=["test"]

     

       7
       +
       tags=["math", "zola"]

     

       8
       +
       

     

       9
       +
       [extra]

     

       10
       +
       math=true

     

       11
       +
       +++

     

       12
       +
       

     

       13
       +
       The usual way to include LaTeX is to use `$$`, as shown in the examples below.

     

       14
       +
       

     

       15
       +
       These examples are taken from <http://khan.github.io/KaTeX/>

     

       16
       +
       

     

       17
       +
       ### Example 1

     

       18
       +
       If the text between `$$` contains newlines it will rendered in display mode:

     

       19
       +
       ```

     

       20
       +
       $$

     

       21
       +
       f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi

     

       22
       +
       $$

     

       23
       +
       ```

     

       24
       +
       

     

       25
       +
       $$

     

       26
       +
       f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi

     

       27
       +
       $$

     

       28
       +
       

     

       29
       +
       ### Example 2

     

       30
       +
       

     

       31
       +
       ```

     

       32
       +
       $$

     

       33
       +
       \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }

     

       34
       +
       $$

     

       35
       +
       

     

       36
       +
       1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } 

     

       37
       +
       ```

     

       38
       +
       

     

       39
       +
       $$

     

       40
       +
       \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }

     

       41
       +
       $$

     

       42
       +
       

     

       43
       +
       1(ϕ5−ϕ)e25π=1+e−2π1+e−4π1+e−6π1+e−8π1+⋯ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } 

     

       44
       +
       

     

       45
       +
       ### Example 3

     

       46
       +
       

     

       47
       +
       ```

     

       48
       +
       $$

     

       49
       +
       1 +  \frac{q^2}{(1-q)}+\frac{q^6}{(1-q)(1-q^2)}+\cdots = \prod_{j=0}^{\infty}\frac{1}{(1-q^{5j+2})(1-q^{5j+3})}, \quad\quad \text{for }\lvert q\rvert<1.

     

       50
       +
       $$

     

       51
       +
       ```

     

       52
       +
       

     

       53
       +
       $$

     

       54
       +
       1 +  \frac{q^2}{(1-q)}+\frac{q^6}{(1-q)(1-q^2)}+\cdots = \prod_{j=0}^{\infty}\frac{1}{(1-q^{5j+2})(1-q^{5j+3})}, \quad\quad \text{for }\lvert q\rvert<1.

     

       55
       +
       $$

     

       56
       +
       

     

       57
       +

+42

themes/zerm/content/waz/index.md

···

       1
       +
       +++

     

       2
       +
       title="waz"

     

       3
       +
       description="a basic demo of zola. Does it work? This old man, he played one. He played knick knack on my drum."

     

       4
       +
       date=2019-03-27

     

       5
       +
       

     

       6
       +
       [taxonomies]

     

       7
       +
       tags = ["rust", "test", "zola"]

     

       8
       +
       categories = ["programming", "misc.", "programming languages"]

     

       9
       +
       

     

       10
       +
       [extra]

     

       11
       +
       +++

     

       12
       +
       

     

       13
       +
       # Hello Hello

     

       14
       +
       

     

       15
       +
       Lorem ipsum dolor sit amet, consectetuer adipiscing elit.  Donec hendrerit

     

       16
       +
       tempor tellus.  Donec pretium posuere tellus.  Proin quam nisl, tincidunt et,

     

       17
       +
       mattis eget, convallis nec, purus.  Cum sociis natoque penatibus et magnis dis

     

       18
       +
       parturient montes, nascetur ridiculus mus.  Nulla posuere.  Donec vitae dolor.

     

       19
       +
       Nullam tristique diam non turpis.  Cras placerat accumsan nulla.  Nullam

     

       20
       +
       rutrum.  Nam vestibulum accumsan nisl.

     

       21
       +
       

     

       22
       +
       

     

       23
       +
       ```python

     

       24
       +
       def foo(bar, **kwargs):

     

       25
       +
           print("yo, this is nice!")

     

       26
       +
       ```

     

       27
       +
       

     

       28
       +
       ## a list

     

       29
       +
       

     

       30
       +
       * Donec hendrerit tempor tellus.

     

       31
       +
       * Nam a sapien.

     

       32
       +
       * Phasellus at dui in ligula mollis ultricies.

     

       33
       +
       * Mauris mollis tincidunt felis.

     

       34
       +
       * Nullam rutrum.

     

       35
       +
       

     

       36
       +
       ### Yet another list

     

       37
       +
       1. Nunc aliquet, augue nec adipiscing interdum, lacus tellus malesuada massa,

     

       38
       +
          quis varius mi purus non odio.

     

       39
       +
       2. Donec hendrerit tempor tellus. 

     

       40
       +
       3. Nunc aliquet, augue nec adipiscing interdum, lacus tellus malesuada massa,

     

       41
       +
          quis varius mi purus non odio.

     

       42
       +

+69

themes/zerm/content/zerm/index.md

···

       1
       +
       +++

     

       2
       +
       title="what is zerm?"

     

       3
       +
       description="a summary of what zerm is and why it is different."

     

       4
       +
       date=2019-08-07

     

       5
       +
       updated=2021-02-03

     

       6
       +
       

     

       7
       +
       [taxonomies]

     

       8
       +
       tags = ["rust", "test", "zola"]

     

       9
       +
       categories = ["programming", "misc.",]

     

       10
       +
       

     

       11
       +
       [extra]

     

       12
       +
       ToC = true

     

       13
       +
       +++

     

       14
       +
       

     

       15
       +
       # hello

     

       16
       +
       

     

       17
       +
       This is zerm, a minimalist theme for Zola based[^1] off of [panr's](https://twitter.com/panr)

     

       18
       +
       theme for Hugo.

     

       19
       +
       

     

       20
       +
       While it's largely faithful to the original, there are some changes:

     

       21
       +
       - no prism.js integration, instead we use Zola's syntax highlighting to reduce overhead.

     

       22
       +
       - removal of PostCSS and leveraging Zola's use of Sass for simple styling.

     

       23
       +
         - much thanks to [Paweł

     

       24
       +
           Romanowski's](https://github.com/pawroman/zola-theme-terminimal/)

     

       25
       +
           independent fork of Terminal. Their Sass stylings saved me the overhead of

     

       26
       +
           figuring it out myself.

     

       27
       +
       - no preview images. I want a theme that is focused on content.

     

       28
       +
       - support for anchor links.

     

       29
       +
       - Other small, opinionated changes that I think lend to the minimalism and

     

       30
       +
         aesthetic of zerm.

     

       31
       +
         

     

       32
       +
         

     

       33
       +
       Things this theme does not have but either Terminal or Terminimal might:

     

       34
       +
       - better short-codes for things like embedding videos or images, though I will

     

       35
       +
         work on this over time.

     

       36
       +
       - better support for things like comments and social media. As of now, I have

     

       37
       +
         no plans to add this but [PR's are always

     

       38
       +
         **welcomed**](https://github.com/ejmg/zerm/pulls).

     

       39
       +
         

     

       40
       +
       ## A quick demo

     

       41
       +
       

     

       42
       +
       `println!("inline code");`

     

       43
       +
       

     

       44
       +
       ```rs

     

       45
       +
       fn main(n: String) {

     

       46
       +
           println!("hello, zola!");

     

       47
       +
       }

     

       48
       +
       ```

     

       49
       +
       

     

       50
       +
       ### Header III

     

       51
       +
       

     

       52
       +
       > a somewhat kinda maybe large quote that maybe spans

     

       53
       +
       > more than one line but I mean really who even cares

     

       54
       +
       > okay maybe I do but point being is yes nice.

     

       55
       +
       

     

       56
       +
       #### Header IV

     

       57
       +
       

     

       58
       +
       | hello | tables    | nice |

     

       59
       +
       |:-----:|:---------:|------|

     

       60
       +
       | wow   | much love | yes  |

     

       61
       +
       

     

       62
       +
         

     

       63
       +
       Like zerm? Then [install

     

       64
       +
       Zola](https://www.getzola.org/documentation/getting-started/installation/) and

     

       65
       +
       [get started](https://www.getzola.org/documentation/themes/installing-and-using-themes/#installing-a-theme)!

     

       66
       +
       

     

       67
       +
       ---

     

       68
       +
       

     

       69
       +
       [^1]: fork? port? a little bit of the former, more of the latter?

themes/zerm/package.json

···

       1
       +
       {

     

       2
       +
           "scripts":

     

       3
       +
           {

     

       4
       +
               "install": "curl -L -O https://github.com/getzola/zola/releases/download/v0.13.0/zola-v0.13.0-x86_64-unknown-linux-gnu.tar.gz && tar -xzf zola-v0.13.0-x86_64-unknown-linux-gnu.tar.gz",

     

       5
       +
               "build": "./zola build"

     

       6
       +
           }

     

       7
       +
       }

+29

themes/zerm/sass/_buttons.scss

···

       1
       +
       button,

     

       2
       +
       .button,

     

       3
       +
       a.button {

     

       4
       +
         position: relative;

     

       5
       +
         display: flex;

     

       6
       +
         align-items: center;

     

       7
       +
         justify-content: center;

     

       8
       +
         padding: 8px 18px;

     

       9
       +
         margin-bottom: 5px;

     

       10
       +
         text-decoration: none;

     

       11
       +
         text-align: center;

     

       12
       +
         border-radius: 8px;

     

       13
       +
         border: 1px solid transparent;

     

       14
       +
         appearance: none;

     

       15
       +
         cursor: pointer;

     

       16
       +
         outline: none;

     

       17
       +
       }

     

       18
       +
       

     

       19
       +
       a.read-more,

     

       20
       +
       a.read-more:hover,

     

       21
       +
       a.read-more:active {

     

       22
       +
         display: inline-flex;

     

       23
       +
         background: none;

     

       24
       +
         box-shadow: none;

     

       25
       +
         padding: 0;

     

       26
       +
         margin: 20px 0;

     

       27
       +
         max-width: 100%;

     

       28
       +
       }

     

       29
       +

+15

themes/zerm/sass/_font.scss

···

       1
       +
       @font-face {

     

       2
       +
           font-family: 'Fira Code';

     

       3
       +
           font-style:  normal;

     

       4
       +
           font-weight: 400;

     

       5
       +
           font-display: swap;

     

       6
       +
           src: url("assets/fonts/FiraCode-Regular.woff2") format("woff2"), url("assets/fonts/FiraCode-Regular.woff") format("woff");

     

       7
       +
       }

     

       8
       +
       

     

       9
       +
       @font-face {

     

       10
       +
           font-family: 'Fira Code';

     

       11
       +
           font-style:  normal;

     

       12
       +
           font-weight: 800;

     

       13
       +
           font-display: swap;

     

       14
       +
           src: url("assets/fonts/FiraCode-Bold.woff2") format("woff2"), url("assets/fonts/FiraCode-Bold.woff") format("woff");

     

       15
       +
       }

+67

themes/zerm/sass/_footer.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       .footer {

     

       4
       +
         padding: 40px 0;

     

       5
       +
         flex-grow: 0;

     

       6
       +
         opacity: .5;

     

       7
       +
       

     

       8
       +
         &__inner {

     

       9
       +
           display: flex;

     

       10
       +
           align-items: center;

     

       11
       +
           justify-content: space-between;

     

       12
       +
           margin: 0;

     

       13
       +
           width: 760px;

     

       14
       +
           max-width: 100%;

     

       15
       +
       

     

       16
       +
           @media (max-width: $tablet-max-width) {

     

       17
       +
             flex-direction: column;

     

       18
       +
           }

     

       19
       +
         }

     

       20
       +
       

     

       21
       +
         a {

     

       22
       +
           color: inherit;

     

       23
       +
         }

     

       24
       +
       

     

       25
       +
         .copyright {

     

       26
       +
           display: flex;

     

       27
       +
           flex-direction: row;

     

       28
       +
           align-items: center;

     

       29
       +
           font-size: 1rem;

     

       30
       +
           // so `--light-color-secondary` color exists no where else in the stylings

     

       31
       +
           // color: var(--light-color-secondary);

     

       32
       +
           // As a substitute, I'm going to use the alpha-70 version of accent.

     

       33
       +
           color: var(--accent-alpha-70);

     

       34
       +
       

     

       35
       +
           &--user {

     

       36
       +
             margin: auto;

     

       37
       +
             text-align: center;

     

       38
       +
           }

     

       39
       +
       

     

       40
       +
           & > *:first-child:not(:only-child) {

     

       41
       +
             margin-right: 10px;

     

       42
       +
       

     

       43
       +
              @media (max-width: $tablet-max-width) {

     

       44
       +
               border: none;

     

       45
       +
               padding: 0;

     

       46
       +
               margin: 0;

     

       47
       +
             }

     

       48
       +
           }

     

       49
       +
       

     

       50
       +
           @media (max-width: $tablet-max-width) {

     

       51
       +
             flex-direction: column;

     

       52
       +
             margin-top: 10px;

     

       53
       +
           }

     

       54
       +
         }

     

       55
       +
       

     

       56
       +
         // .copyright-theme-sep {

     

       57
       +
         //   @media (max-width: $tablet-max-width) {

     

       58
       +
         //     display: none;

     

       59
       +
         //   }

     

       60
       +
         // }

     

       61
       +
       

     

       62
       +
         // .copyright-theme {

     

       63
       +
         //   @media (max-width: $tablet-max-width) {

     

       64
       +
         //     font-size: 0.75rem;

     

       65
       +
         //   }

     

       66
       +
         // }

     

       67
       +
       }

+139

themes/zerm/sass/_header.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       @mixin menu {

     

       4
       +
         background: var(--background);

     

       5
       +
         box-shadow: var(--shadow);

     

       6
       +
         color: var(--color);

     

       7
       +
         border: 2px solid;

     

       8
       +
         margin: 0;

     

       9
       +
         padding: 10px;

     

       10
       +
         list-style: none;

     

       11
       +
         z-index: 99;

     

       12
       +
       }

     

       13
       +
       

     

       14
       +
       .header {

     

       15
       +
         display: flex;

     

       16
       +
         flex-direction: column;

     

       17
       +
         position: relative;

     

       18
       +
       

     

       19
       +
         &__inner {

     

       20
       +
           display: flex;

     

       21
       +
           align-items: center;

     

       22
       +
           justify-content: space-between;

     

       23
       +
         }

     

       24
       +
       

     

       25
       +
         &__logo {

     

       26
       +
           display: flex;

     

       27
       +
           flex: 1;

     

       28
       +
       

     

       29
       +
           &:after {

     

       30
       +
             content: '';

     

       31
       +
             background: repeating-linear-gradient(90deg, var(--accent), var(--accent) 2px, transparent 0, transparent 10px);

     

       32
       +
             display: block;

     

       33
       +
             width: 100%;

     

       34
       +
             right: 10px;

     

       35
       +
           }

     

       36
       +
       

     

       37
       +
           a {

     

       38
       +
             flex: 0 0 auto;

     

       39
       +
             max-width: 100%;

     

       40
       +
             text-decoration: none;

     

       41
       +
           }

     

       42
       +
         }

     

       43
       +
       

     

       44
       +
         .menu {

     

       45
       +
           margin: 20px 0;

     

       46
       +
           --shadow-color: var(--accent-alpha-70);

     

       47
       +
           --shadow: 0 10px var(--shadow-color), -10px 10px var(--shadow-color), 10px 10px var(--shadow-color);

     

       48
       +
       

     

       49
       +
           @media (max-width: $phone-max-width) {

     

       50
       +
               @include menu;

     

       51
       +
               position: absolute;

     

       52
       +
               top: 50px;

     

       53
       +
               right: 0;

     

       54
       +
           }

     

       55
       +
       

     

       56
       +
           &__inner {

     

       57
       +
             // @include menu;

     

       58
       +
             display: flex;

     

       59
       +
             flex-wrap: wrap;

     

       60
       +
             list-style: none;

     

       61
       +
             margin: 0;

     

       62
       +
             padding: 0;

     

       63
       +
       

     

       64
       +
             &--desktop {

     

       65
       +
                 @media (max-width: $phone-max-width) {

     

       66
       +
                     display: none;

     

       67
       +
                 }

     

       68
       +
             }

     

       69
       +
       

     

       70
       +
             &--mobile {

     

       71
       +
               display: none;

     

       72
       +
       

     

       73
       +
               @media (max-width: $phone-max-width) {

     

       74
       +
                 display: block;

     

       75
       +
               }

     

       76
       +
             }

     

       77
       +
       

     

       78
       +
             li {

     

       79
       +
               // &.active {

     

       80
       +
               //   color: var(--accent-alpha-70);

     

       81
       +
               // }

     

       82
       +
               &:not(:last-of-type) {

     

       83
       +
                 margin-right: 20px;

     

       84
       +
                 margin-bottom: 10px;

     

       85
       +
                 flex: 0 0 auto;

     

       86
       +
               }

     

       87
       +
             }

     

       88
       +
       

     

       89
       +
             @media (max-width: $phone-max-width) {

     

       90
       +
               flex-direction: column;

     

       91
       +
               align-items: flex-start;

     

       92
       +
               padding: 0;

     

       93
       +
       

     

       94
       +
               li {

     

       95
       +
                 margin: 0;

     

       96
       +
                 padding: 5px;

     

       97
       +
               }

     

       98
       +
             }

     

       99
       +
           }

     

       100
       +
       

     

       101
       +
           &__sub-inner {

     

       102
       +
             position: relative;

     

       103
       +
             list-style: none;

     

       104
       +
             padding: 0;

     

       105
       +
             margin: 0;

     

       106
       +
       

     

       107
       +
             &:not(:only-child) {

     

       108
       +
               margin-left: 20px;

     

       109
       +
             }

     

       110
       +
       

     

       111
       +
             &-more {

     

       112
       +
               @include menu;

     

       113
       +
               top: 35px;

     

       114
       +
               left: 0;

     

       115
       +
       

     

       116
       +
               &-trigger {

     

       117
       +
                 color: var(--accent);

     

       118
       +
                 user-select: none;

     

       119
       +
                 cursor: pointer;

     

       120
       +
               }

     

       121
       +
       

     

       122
       +
               li {

     

       123
       +
                 margin: 0;

     

       124
       +
                 padding: 5px;

     

       125
       +
                 white-space: nowrap;

     

       126
       +
               }

     

       127
       +
             }

     

       128
       +
           }

     

       129
       +
             

     

       130
       +
           &-trigger {

     

       131
       +
             color: var(--accent);

     

       132
       +
             border: 2px solid;

     

       133
       +
             margin-left: 10px;

     

       134
       +
             height: 100%;

     

       135
       +
             padding: 3px 8px;

     

       136
       +
             position: relative;

     

       137
       +
           }

     

       138
       +
         }

     

       139
       +
       }

themes/zerm/sass/_logo.scss

···

       1
       +
       .logo {

     

       2
       +
         display: flex;

     

       3
       +
         align-items: center;

     

       4
       +
         text-decoration: none;

     

       5
       +
         background: var(--accent);

     

       6
       +
         color: black;

     

       7
       +
         padding: 5px 10px;

     

       8
       +
       }

+335

themes/zerm/sass/_main.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       html {

     

       4
       +
         box-sizing: border-box;

     

       5
       +
       }

     

       6
       +
       

     

       7
       +
       *,

     

       8
       +
       *:before,

     

       9
       +
       *:after {

     

       10
       +
         box-sizing: inherit;

     

       11
       +
       }

     

       12
       +
       

     

       13
       +
       body {

     

       14
       +
         margin: 0;

     

       15
       +
         padding: 0;

     

       16
       +
         font-family: 'Fira Code', Menlo, DejaVu Sans Mono, Monaco, Consolas, Ubuntu Mono, monospace;

     

       17
       +
         font-size: 1rem;

     

       18
       +
         line-height: 1.54;

     

       19
       +
         background-color: var(--background);

     

       20
       +
         color: var(--color);

     

       21
       +
         text-rendering: optimizeLegibility;

     

       22
       +
         -webkit-font-smoothing: antialiased;

     

       23
       +
         -webkit-overflow-scrolling: touch;

     

       24
       +
         -webkit-text-size-adjust: 100%;

     

       25
       +
         font-feature-settings: "liga";

     

       26
       +
       

     

       27
       +
         @media (max-width: $phone-max-width) {

     

       28
       +
           font-size: 1rem;

     

       29
       +
         }

     

       30
       +
       }

     

       31
       +
       

     

       32
       +
       h1, h2, h3, h4, h5, h6 {

     

       33
       +
         line-height: 1.3;

     

       34
       +
       

     

       35
       +
         &:not(first-child) {

     

       36
       +
           margin-top: 40px;

     

       37
       +
         }

     

       38
       +
       

     

       39
       +
         .zola-anchor {

     

       40
       +
           font-size: 1.5rem;

     

       41
       +
           visibility: hidden;

     

       42
       +
           margin-left: 0.5rem;

     

       43
       +
           vertical-align: 1%;

     

       44
       +
           text-decoration: none;

     

       45
       +
           border-bottom-color: transparent;

     

       46
       +
           cursor: pointer;

     

       47
       +
       

     

       48
       +
           @media(max-width: $phone-max-width){

     

       49
       +
               visibility: visible;

     

       50
       +
           }

     

       51
       +
         }

     

       52
       +
       

     

       53
       +
         &:hover {

     

       54
       +
           .zola-anchor {

     

       55
       +
             visibility: visible;

     

       56
       +
           }

     

       57
       +
         }

     

       58
       +
       }

     

       59
       +
       

     

       60
       +
       // Actually keeping Pawroman's stylings here for font-size over h1-h6.

     

       61
       +
       // I prefer differentiated header height.

     

       62
       +
       

     

       63
       +
       // OLD

     

       64
       +
       // ---------------------

     

       65
       +
       // h1, h2, h3 {

     

       66
       +
       //   font-size: 1.4rem;

     

       67
       +
       // }

     

       68
       +
       

     

       69
       +
       // h4, h5, h6 {

     

       70
       +
       //   font-size: 1.2rem;

     

       71
       +
       // }

     

       72
       +
       

     

       73
       +
       // Pawroman's

     

       74
       +
       // ---------------------

     

       75
       +
       h1 {

     

       76
       +
         font-size: 1.4rem;

     

       77
       +
       }

     

       78
       +
       

     

       79
       +
       h2 {

     

       80
       +
         font-size: 1.3rem;

     

       81
       +
       }

     

       82
       +
       

     

       83
       +
       h3 {

     

       84
       +
         font-size: 1.2rem;

     

       85
       +
       }

     

       86
       +
       

     

       87
       +
       h4, h5, h6 {

     

       88
       +
         font-size: 1.15rem;

     

       89
       +
       }

     

       90
       +
       

     

       91
       +
       

     

       92
       +
       a {

     

       93
       +
         color: inherit;

     

       94
       +
       }

     

       95
       +
       

     

       96
       +
       img {

     

       97
       +
         display: block;

     

       98
       +
         max-width: 100%;

     

       99
       +
       

     

       100
       +
         &.left {

     

       101
       +
           margin-right: auto;

     

       102
       +
         }

     

       103
       +
       

     

       104
       +
         &.center {

     

       105
       +
           margin-left: auto;

     

       106
       +
           margin-right: auto;

     

       107
       +
         }

     

       108
       +
       

     

       109
       +
         &.right {

     

       110
       +
           margin-left: auto;

     

       111
       +
         }

     

       112
       +
       }

     

       113
       +
       

     

       114
       +
       p {

     

       115
       +
         margin-bottom: 20px;

     

       116
       +
       }

     

       117
       +
       

     

       118
       +
       figure {

     

       119
       +
         display: table;

     

       120
       +
         max-width: 100%;

     

       121
       +
         margin: 25px 0;

     

       122
       +
       

     

       123
       +
         &.left {

     

       124
       +
           // img {

     

       125
       +
             margin-right: auto;

     

       126
       +
           // }

     

       127
       +
         }

     

       128
       +
       

     

       129
       +
         &.center {

     

       130
       +
           // img {

     

       131
       +
             margin-left: auto;

     

       132
       +
             margin-right: auto;

     

       133
       +
           // }

     

       134
       +
         }

     

       135
       +
       

     

       136
       +
         &.right {

     

       137
       +
           // img {

     

       138
       +
             margin-left: auto;

     

       139
       +
           // }

     

       140
       +
         }

     

       141
       +
       

     

       142
       +
         figcaption {

     

       143
       +
           font-size: 14px;

     

       144
       +
           padding: 5px 10px;

     

       145
       +
           margin-top: 5px;

     

       146
       +
           background: var(--accent);

     

       147
       +
           color: var(--background);

     

       148
       +
       

     

       149
       +
           &.left {

     

       150
       +
             text-align: left;

     

       151
       +
           }

     

       152
       +
       

     

       153
       +
           &.center {

     

       154
       +
             text-align: center;

     

       155
       +
           }

     

       156
       +
       

     

       157
       +
           &.right {

     

       158
       +
             text-align: right;

     

       159
       +
           }

     

       160
       +
         }

     

       161
       +
       }

     

       162
       +
       

     

       163
       +
       code {

     

       164
       +
         font-family: 'Fira Code', Menlo, DejaVu Sans Mono, Monaco, Consolas, Ubuntu Mono, monospace;

     

       165
       +
         font-feature-settings: normal;

     

       166
       +
         background: var(--accent-alpha-20);

     

       167
       +
         color: var(--accent);

     

       168
       +
         padding: 1px 6px;

     

       169
       +
         margin: 0 2px;

     

       170
       +
         font-size: .95rem;

     

       171
       +
       }

     

       172
       +
       

     

       173
       +
       pre {

     

       174
       +
         font-family: 'Fira Code', Menlo, DejaVu Sans Mono, Monaco, Consolas, Ubuntu Mono, monospace;

     

       175
       +
         font-feature-settings: "liga";  

     

       176
       +
         padding: 20px 10px;

     

       177
       +
         font-size: .95rem;

     

       178
       +
         overflow: auto;

     

       179
       +
         border-top: 1px solid rgba(255, 255, 255, .1);

     

       180
       +
         border-bottom: 1px solid rgba(255, 255, 255, .1);

     

       181
       +
       

     

       182
       +
         + pre {

     

       183
       +
           border-top: 0;

     

       184
       +
           margin-top: -40px;

     

       185
       +
         }

     

       186
       +
         

     

       187
       +
         @media (max-width: $phone-max-width) {

     

       188
       +
           white-space: pre-wrap;

     

       189
       +
           word-wrap: break-word;

     

       190
       +
         }

     

       191
       +
       

     

       192
       +
           code {

     

       193
       +
             background: none !important;

     

       194
       +
             margin: 0;

     

       195
       +
             padding: 0;

     

       196
       +
             font-size: inherit;

     

       197
       +
             border: none;

     

       198
       +
       

     

       199
       +
             table {

     

       200
       +
               table-layout: auto;

     

       201
       +
               border-collapse: collapse;

     

       202
       +
               box-sizing: border-box;

     

       203
       +
               width: 100%;

     

       204
       +
               margin: 00px 0;

     

       205
       +
             }

     

       206
       +
       

     

       207
       +
             table, th, td {

     

       208
       +
               border: none;

     

       209
       +
               padding: 0px;

     

       210
       +
             }

     

       211
       +
       

     

       212
       +
             table tr td:first-child {

     

       213
       +
               padding-right: 10px;

     

       214
       +
             }

     

       215
       +
       

     

       216
       +
         }

     

       217
       +
       }

     

       218
       +
       

     

       219
       +
       blockquote {

     

       220
       +
         border-top: 1px solid var(--accent);

     

       221
       +
         border-bottom: 1px solid var(--accent);

     

       222
       +
         margin: 40px 0;

     

       223
       +
         padding: 25px;

     

       224
       +
       

     

       225
       +
         @media (max-width: $phone-max-width) {

     

       226
       +
           padding-right: 0;

     

       227
       +
         }

     

       228
       +
       

     

       229
       +
         &:before {

     

       230
       +
           content: '”';

     

       231
       +
           font-family: Georgia, serif;

     

       232
       +
           font-size: 3.875rem;

     

       233
       +
           position: absolute;

     

       234
       +
           left: -40px;

     

       235
       +
           top: -20px;

     

       236
       +
         }

     

       237
       +
       

     

       238
       +
         p:first-of-type {

     

       239
       +
           margin-top: 0;

     

       240
       +
         }

     

       241
       +
       

     

       242
       +
         p:last-of-type {

     

       243
       +
           margin-bottom: 0;

     

       244
       +
         }

     

       245
       +
       

     

       246
       +
         p {

     

       247
       +
           position: relative;

     

       248
       +
         }

     

       249
       +
       

     

       250
       +
         p:before {

     

       251
       +
           content: '>';

     

       252
       +
           display: block;

     

       253
       +
           position: absolute;

     

       254
       +
           left: -25px;

     

       255
       +
           color: var(--accent);

     

       256
       +
         }

     

       257
       +
       }

     

       258
       +
       

     

       259
       +
       table {

     

       260
       +
         table-layout: fixed;

     

       261
       +
         border-collapse: collapse;

     

       262
       +
         width: 100%;

     

       263
       +
         margin: 40px 0;

     

       264
       +
       }

     

       265
       +
       

     

       266
       +
       table, th, td {

     

       267
       +
         border: 1px dashed var(--accent);

     

       268
       +
         padding: 10px;

     

       269
       +
       }

     

       270
       +
       

     

       271
       +
       th {

     

       272
       +
         color: var(--accent);

     

       273
       +
       }

     

       274
       +
       

     

       275
       +
       ul, ol {

     

       276
       +
         margin-left: 30px;

     

       277
       +
         padding: 0;

     

       278
       +
       

     

       279
       +
         li {

     

       280
       +
             position: relative;

     

       281
       +
             margin-top: 5px;

     

       282
       +
             margin-bottom: 5px;

     

       283
       +
         }

     

       284
       +
       

     

       285
       +
         @media (max-width: $phone-max-width) {

     

       286
       +
           margin-left: 20px;

     

       287
       +
         }

     

       288
       +
       

     

       289
       +
         ul, ol {

     

       290
       +
             margin-top: 10px;

     

       291
       +
             margin-bottom: 10px;

     

       292
       +
         }

     

       293
       +
       }

     

       294
       +
       

     

       295
       +
       ol ol {

     

       296
       +
         list-style-type: lower-alpha;

     

       297
       +
       }

     

       298
       +
       

     

       299
       +
       .container {

     

       300
       +
         display: flex;

     

       301
       +
         flex-direction: column;

     

       302
       +
         padding: 40px;

     

       303
       +
         max-width: 864px;

     

       304
       +
         min-height: 100vh;

     

       305
       +
         border-right: 1px solid rgba(255, 255, 255, 0.1);

     

       306
       +
       

     

       307
       +
         &.full,

     

       308
       +
         &.center {

     

       309
       +
           border: none;

     

       310
       +
           margin: 0 auto;

     

       311
       +
         }

     

       312
       +
       

     

       313
       +
         &.full {

     

       314
       +
           max-width: 100%;

     

       315
       +
         }

     

       316
       +
       

     

       317
       +
         @media (max-width: $phone-max-width) {

     

       318
       +
           padding: 20px;

     

       319
       +
         }

     

       320
       +
       }

     

       321
       +
       

     

       322
       +
       .content {

     

       323
       +
         display: flex;

     

       324
       +
       }

     

       325
       +
       

     

       326
       +
       hr {

     

       327
       +
         width: 100%;

     

       328
       +
         border: none;

     

       329
       +
         background: var(--border-color);

     

       330
       +
         height: 1px;

     

       331
       +
       }

     

       332
       +
       

     

       333
       +
       .hidden {

     

       334
       +
         display: none;

     

       335
       +
       }

+63

themes/zerm/sass/_pagination.scss

···

       1
       +
       @import 'variables';

     

       2
       +
       

     

       3
       +
       .pagination {

     

       4
       +
         margin-top: 50px;

     

       5
       +
       

     

       6
       +
         &__buttons {

     

       7
       +
           display: flex;

     

       8
       +
           align-items: center;

     

       9
       +
           justify-content: center;

     

       10
       +
       

     

       11
       +
           // @media (max-width: $phone-max-width) {

     

       12
       +
           //   flex-direction: column;

     

       13
       +
           // }

     

       14
       +
       

     

       15
       +
           a {

     

       16
       +
               text-decoration: none;

     

       17
       +
           }

     

       18
       +
         }

     

       19
       +
       }

     

       20
       +
       

     

       21
       +
       .button {

     

       22
       +
         position: relative;

     

       23
       +
         display: inline-flex;

     

       24
       +
         align-items: center;

     

       25
       +
         justify-content: center;

     

       26
       +
         font-size: 1rem;

     

       27
       +
         border-radius: 8px;

     

       28
       +
         max-width: 40%;

     

       29
       +
         padding: 0;

     

       30
       +
         cursor: pointer;

     

       31
       +
         appearance: none;

     

       32
       +
       

     

       33
       +
         + .button {

     

       34
       +
             margin-left: 10px;

     

       35
       +
         }

     

       36
       +
       

     

       37
       +
         // @media (max-width: $phone-max-width) {

     

       38
       +
         //   max-width: 80%;

     

       39
       +
         // }

     

       40
       +
       

     

       41
       +
         a {

     

       42
       +
           display: flex;

     

       43
       +
           padding: 8px 16px;

     

       44
       +
           text-decoration: none;

     

       45
       +
           text-overflow: ellipsis;

     

       46
       +
           white-space: nowrap;

     

       47
       +
           overflow: hidden;

     

       48
       +
         }

     

       49
       +
       

     

       50
       +
         &__text {

     

       51
       +
           text-overflow: ellipsis;

     

       52
       +
           white-space: nowrap;

     

       53
       +
           overflow: hidden;

     

       54
       +
         }

     

       55
       +
       

     

       56
       +
         &.next .button__icon {

     

       57
       +
           margin-left: 8px;

     

       58
       +
         }

     

       59
       +
       

     

       60
       +
         &.previous .button__icon {

     

       61
       +
           margin-right: 8px;

     

       62
       +
         }

     

       63
       +
       }

+114

themes/zerm/sass/_post.scss

···

       1
       +
       @import "variables";

     

       2
       +
       

     

       3
       +
       // .posts {

     

       4
       +
       //   margin: 0 auto;

     

       5
       +
       // }

     

       6
       +
       

     

       7
       +
       .post {

     

       8
       +
         width: 100%;

     

       9
       +
         text-align: left;

     

       10
       +
         margin: 20px auto;

     

       11
       +
         padding: 20px 0;

     

       12
       +
       

     

       13
       +
         @media (max-width: $tablet-max-width) {

     

       14
       +
           max-width: 660px;

     

       15
       +
         }

     

       16
       +
       

     

       17
       +
         &:not(:last-of-type) {

     

       18
       +
           border-bottom: 1px solid var(--border-color);

     

       19
       +
         }

     

       20
       +
       

     

       21
       +
         // %meta {

     

       22
       +
         //   font-size: 1rem;

     

       23
       +
         //   margin-bottom: 10px;

     

       24
       +
         //   color: var(--accent-alpha-70);

     

       25
       +
         // }

     

       26
       +
       

     

       27
       +
         // &-meta {

     

       28
       +
         //   @extend %meta;

     

       29
       +
         // }

     

       30
       +
         // &-meta-inline {

     

       31
       +
         //   @extend %meta;

     

       32
       +
       

     

       33
       +
         //   display: inline;

     

       34
       +
         // }

     

       35
       +
       

     

       36
       +
         &-meta {

     

       37
       +
           font-size: 1rem;

     

       38
       +
           margin-bottom: 10px;

     

       39
       +
           color: var(--accent-alpha-70);

     

       40
       +
         }

     

       41
       +
       

     

       42
       +
         &-title {

     

       43
       +
           --border: 3px dotted var(--accent);

     

       44
       +
           position: relative;

     

       45
       +
           color: var(--accent);

     

       46
       +
           margin: 0 0 15px;

     

       47
       +
           padding-bottom: 15px;

     

       48
       +
           border-bottom: var(--border);

     

       49
       +
       

     

       50
       +
           &:after {

     

       51
       +
             content: '';

     

       52
       +
             position: absolute;

     

       53
       +
             bottom: 2px;

     

       54
       +
             display: block;

     

       55
       +
             width: 100%;

     

       56
       +
             border-bottom: var(--border);

     

       57
       +
           }

     

       58
       +
           

     

       59
       +
           a {

     

       60
       +
             text-decoration: none;

     

       61
       +
           }

     

       62
       +
         }

     

       63
       +
       

     

       64
       +
         &-content {

     

       65
       +
           margin-top: 30px;

     

       66
       +
         }

     

       67
       +
       

     

       68
       +
         ul {

     

       69
       +
           list-style: none;

     

       70
       +
       

     

       71
       +
           li:before {

     

       72
       +
             content: '⦿';

     

       73
       +
             position: absolute;

     

       74
       +
             left: -20px;

     

       75
       +
             color: var(--accent);

     

       76
       +
           }

     

       77
       +
           ul {

     

       78
       +
       

     

       79
       +
             li:before {

     

       80
       +
               content: '■';

     

       81
       +
               position: absolute;

     

       82
       +
               left: -20px;

     

       83
       +
               color: var(--accent);

     

       84
       +
             }

     

       85
       +
       

     

       86
       +
             ul {

     

       87
       +
       

     

       88
       +
               li:before {

     

       89
       +
                 content: '►';

     

       90
       +
                 position: absolute;

     

       91
       +
                 left: -20px;

     

       92
       +
                 color: var(--accent);

     

       93
       +
               }

     

       94
       +
             }

     

       95
       +
           }

     

       96
       +
         }

     

       97
       +
       }

     

       98
       +
       

     

       99
       +
       // TODO: try adapting this using a properly nested selector in the block above

     

       100
       +
       //       for ul items.

     

       101
       +
       .tag-list {

     

       102
       +
           @media(max-width: $phone-max-width) {

     

       103
       +
               margin-left: 5%;

     

       104
       +
           }

     

       105
       +
       }

     

       106
       +
       

     

       107
       +
       .footnote-definition {

     

       108
       +
         color: var(--accent);

     

       109
       +
       

     

       110
       +
         p {

     

       111
       +
           display: inline;

     

       112
       +
           color: var(--footnote-color);

     

       113
       +
         }

     

       114
       +
       }

themes/zerm/sass/_semantic.scss

···

       1
       +
       section, article, aside, footer, header, nav {

     

       2
       +
           display: block;

     

       3
       +
       }

themes/zerm/sass/_toc.scss

···

       1
       +
       div.toc {

     

       2
       +
       	--shadow-color: var(--accent-alpha-70);

     

       3
       +
           --shadow: 10px 10px var(--shadow-color);

     

       4
       +
       	@include menu;	

     

       5
       +
       	margin: 20px 0;

     

       6
       +
       }

+10

themes/zerm/sass/_variables.scss

···

       1
       +
       :root {

     

       2
       +
         // *NOTE*:

     

       3
       +
         // ------------------------------------------------

     

       4
       +
         //Keep the same as the values in variables.scss!!!!!

     

       5
       +
         --phoneWidth: (max-width: 684px);

     

       6
       +
         --tabletWidth: (max-width: 900px);

     

       7
       +
       }

     

       8
       +
       

     

       9
       +
       $phone-max-width: 683px;

     

       10
       +
       $tablet-max-width: 899px;

themes/zerm/sass/color/blue.scss

···

       1
       +
       :root {

     

       2
       +
         --accent: rgb(35,176,255);

     

       3
       +
         --accent-alpha-20: rgba(35,176,255,.2);

     

       4
       +
         --accent-alpha-70: rgba(35,176,255,.7);

     

       5
       +
         --background: #1D1E28;

     

       6
       +
         --color: whitesmoke;

     

       7
       +
         --border-color: rgba(255, 255, 255, .1);

     

       8
       +
         --footnote-color: rgba(255, 255, 255, .5);

     

       9
       +
       }

+12

themes/zerm/sass/color/green.scss

···

       1
       +
       :root {

     

       2
       +
         // --accent: rgb(120,226,160);

     

       3
       +
         // --accent-alpha-20: rgba(120,226,160,.2);

     

       4
       +
         // --accent-alpha-70: rgba(120,226,160,.7);

     

       5
       +
         --accent: rgb(72, 251, 53);

     

       6
       +
         --accent-alpha-20: rgba(72, 251, 53,.2);

     

       7
       +
         --accent-alpha-70: rgba(72, 251, 53,.7);

     

       8
       +
         --background: #1F222A;

     

       9
       +
         --color: whitesmoke;

     

       10
       +
         --border-color: rgba(255, 255, 255, .1);

     

       11
       +
         --footnote-color: rgba(255, 255, 255, .5);

     

       12
       +
       }

themes/zerm/sass/color/orange.scss

···

       1
       +
       :root {

     

       2
       +
         --accent: rgb(255,168,106);

     

       3
       +
         --accent-alpha-20: rgba(255, 168, 106, .2);

     

       4
       +
         --accent-alpha-70: rgba(255, 168, 106,.7);

     

       5
       +
         --background: #211f1a;

     

       6
       +
         --color: whitesmoke;

     

       7
       +
         --border-color: rgba(255, 255, 255, .1);

     

       8
       +
         --footnote-color: rgba(255, 255, 255, .5);

     

       9
       +
       }

themes/zerm/sass/color/pink.scss

···

       1
       +
       :root {

     

       2
       +
         --accent: rgb(238,114,241);

     

       3
       +
         --accent-alpha-20: rgba(238,114,241,.2);

     

       4
       +
         --accent-alpha-70: rgba(238,114,241,.7);

     

       5
       +
         --background: #21202C;

     

       6
       +
         --color: whitesmoke;

     

       7
       +
         --border-color: rgba(255, 255, 255, .1);

     

       8
       +
         --footnote-color: rgba(255, 255, 255, .5);

     

       9
       +
       }

themes/zerm/sass/color/red.scss

···

       1
       +
       :root {

     

       2
       +
         --accent: rgb(255,98,102);

     

       3
       +
         --accent-alpha-20: rgba(255,98,102,.2);

     

       4
       +
         --accent-alpha-70: rgba(255,98,102,.7);

     

       5
       +
         --background: #221F29;

     

       6
       +
         --color: whitesmoke;

     

       7
       +
         --border-color: rgba(255, 255, 255, .1);

     

       8
       +
         --footnote-color: rgba(255, 255, 255, .5);

     

       9
       +
       }

+10

themes/zerm/sass/style.scss

···

       1
       +
       @import 'buttons';

     

       2
       +
       @import 'font';

     

       3
       +
       @import 'header';

     

       4
       +
       @import 'logo';

     

       5
       +
       @import 'main';

     

       6
       +
       @import 'post';

     

       7
       +
       @import 'pagination';

     

       8
       +
       @import 'footer';

     

       9
       +
       @import 'semantic';

     

       10
       +
       @import 'toc';

themes/zerm/screenshot.png

This is a binary file and will not be displayed.

themes/zerm/static/assets/js/main.js

···

       0

···

       1
       +
       !function(e){var t={};function n(o){if(t[o])return t[o].exports;var r=t[o]={i:o,l:!1,exports:{}};return e[o].call(r.exports,r,r.exports,n),r.l=!0,r.exports}n.m=e,n.c=t,n.d=function(e,t,o){n.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:o})},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},n.t=function(e,t){if(1&t&&(e=n(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var o=Object.create(null);if(n.r(o),Object.defineProperty(o,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var r in e)n.d(o,r,function(t){return e[t]}.bind(null,r));return o},n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,"a",t),t},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.p="",n(n.s=0)}([function(e,t,n){n(1),e.exports=n(2)},function(e,t){},function(e,t){var n=document.querySelector(".container"),o=document.querySelector(".menu"),r=document.querySelector(".menu-trigger"),i=(document.querySelector(".menu__inner--desktop"),document.querySelector(".menu__sub-inner-more-trigger")),u=document.querySelector(".menu__sub-inner-more"),c=getComputedStyle(document.body).getPropertyValue("--phoneWidth"),d=function(){return window.matchMedia(c).matches},s=function(){r&&r.classList.toggle("hidden",!d()),o&&o.classList.toggle("hidden",d()),u&&u.classList.toggle("hidden",!d())};o&&o.addEventListener("click",function(e){return e.stopPropagation()}),u&&u.addEventListener("click",function(e){return e.stopPropagation()}),s(),document.body.addEventListener("click",function(){d()||!u||u.classList.contains("hidden")?d()&&!o.classList.contains("hidden")&&o.classList.add("hidden"):u.classList.add("hidden")}),window.addEventListener("resize",s),r&&r.addEventListener("click",function(e){e.stopPropagation(),o&&o.classList.toggle("hidden")}),i&&i.addEventListener("click",function(e){e.stopPropagation(),u&&u.classList.toggle("hidden"),u.getBoundingClientRect().right>n.getBoundingClientRect().right&&(u.style.left="auto",u.style.right=0)})}]);

themes/zerm/templates/.gitignore

···

       0

···

       1
       +
       !tags

+12

themes/zerm/templates/404.html

···

       1
       +
       {% extends "index.html" -%}

     

       2
       +
       

     

       3
       +
       {%- block title %}

     

       4
       +
           <title>Page not found</title>

     

       5
       +
       {%- endblock title -%}

     

       6
       +
       

     

       7
       +
       {%- block main -%}

     

       8
       +
       

     

       9
       +
       Sorry, this page doesn't exist.

     

       10
       +
       

     

       11
       +
       Go back&nbsp<a href="{%- if config.extra.logo_home_link -%}{{ config.extra.logo_home_link }}{%- else -%}{{ config.base_url }}{%- endif -%}">home?</a>

     

       12
       +
       {%- endblock main -%}

themes/zerm/templates/anchor-link.html

···

       0

···

       1
       +
       <a class="zola-anchor" href="#{{ id }}" aria-label="Anchor link for: {{ id }}">§</a>

+18

themes/zerm/templates/categories/list.html

···

       1
       +
       {% extends "index.html" %}

     

       2
       +
       {%- block main -%}

     

       3
       +
           <div class="post">

     

       4
       +
       

     

       5
       +
               <h1 class="post-title">{categories}</h1>

     

       6
       +
               <ul>

     

       7
       +
                   {%- for cat in terms -%}

     

       8
       +
                       <li class="tag-list">

     

       9
       +
                           <a href="{{ get_taxonomy_url(kind="categories", name=cat.name) }}">{{ "{" }}{{ cat.name }}{{ "}" }}</a>

     

       10
       +
                           ({{ cat.pages | length }} post{{ cat.pages | length | pluralize }})

     

       11
       +
                       </li>

     

       12
       +
                       {# End of pagination for-loop #}

     

       13
       +
                   {%- endfor -%}

     

       14
       +
                   {#- I don't put pagination here like Terminal does. I don't like how

     

       15
       +
                   the buttons move with the size of post entries in the content div. -#}

     

       16
       +
               </ul>

     

       17
       +
           </div>

     

       18
       +
       {%- endblock main -%}

+30

themes/zerm/templates/categories/single.html

···

       1
       +
       {%- extends "index.html"-%}

     

       2
       +
       {%- block main-%}

     

       3
       +
           <div class="post">

     

       4
       +
               <h1 class="post-title">

     

       5
       +
                   categories ∋ {{ "{" }}{{ term.name }}{{ "}" }}

     

       6
       +
                   ({{ term.pages | length }} post{{ term.pages | length | pluralize }})

     

       7
       +
               </h1>

     

       8
       +
       

     

       9
       +
               <ul>

     

       10
       +
                   {%- for post in term.pages -%}

     

       11
       +
                       <li class="tag-list">

     

       12
       +
                           {{ post.date | date(format="%Y.%m.%d") }}

     

       13
       +
                           :: <a href="{{ post.permalink }}">{{ post.title }}</a>

     

       14
       +
                           :: {{ "{" }}

     

       15
       +
                           {%- for cat in post.taxonomies["categories"] -%}

     

       16
       +
                               {%- set _cat = get_taxonomy_url(kind="categories", name=cat) -%}

     

       17
       +
                               {%- if loop.last -%}

     

       18
       +
                                   <a href="{{ _cat }}">{{ cat }}</a>

     

       19
       +
                               {%- else -%}

     

       20
       +
                                   <a href="{{ _cat }}">{{ cat }}</a>,&nbsp;

     

       21
       +
                               {%- endif -%}

     

       22
       +
                           {% endfor %}{{ "}" }}

     

       23
       +
                       </li>

     

       24
       +
                       {# End of pagination for-loop #}

     

       25
       +
                   {%- endfor -%}

     

       26
       +
                   {#- I don't put pagination here like Terminal does. I don't like how

     

       27
       +
                   the buttons move with the size of post entries in the content div. -#}

     

       28
       +
           </ul>

     

       29
       +
       </div>

     

       30
       +
       {%- endblock main-%}

+97

themes/zerm/templates/index.html

···

       1
       +
       {% import "macros/head.html" as head -%}

     

       2
       +
       {% import "macros/logo.html" as logo -%}

     

       3
       +
       {% import "macros/header.html" as header -%}

     

       4
       +
       {% import "macros/extended_header.html" as extended_header -%}

     

       5
       +
       {% import "macros/lists.html" as lists -%}

     

       6
       +
       {% import "macros/posts.html" as posts -%}

     

       7
       +
       {% import "macros/social.html" as social -%}

     

       8
       +
       {% import "macros/utils.html" as utils -%}

     

       9
       +
       {% import "macros/menu.html" as menu -%}

     

       10
       +
       {% import "macros/pagination.html" as pagination -%}

     

       11
       +
       {% import "macros/footer.html" as footer -%}

     

       12
       +
       {% import "macros/extended_footer.html" as extended_footer -%}

     

       13
       +
       {% import "macros/comments.html" as comments -%}

     

       14
       +
       

     

       15
       +
       <!DOCTYPE html>

     

       16
       +
       <html lang="{{ lang }}">

     

       17
       +
           <head>

     

       18
       +
               {%- block title -%}

     

       19
       +
                   <title>{{ config.title }}</title>

     

       20
       +
               {%- endblock title -%}

     

       21
       +
       

     

       22
       +
               {%- block general_meta -%}

     

       23
       +
                   {{ head::general_meta() }}

     

       24
       +
               {%- endblock general_meta -%}

     

       25
       +
       

     

       26
       +
               {%- block og_preview -%}

     

       27
       +
                   {{ social::og_preview() }}

     

       28
       +
               {%- endblock og_preview -%}

     

       29
       +
       

     

       30
       +
               {%- block fonts -%}

     

       31
       +
                   {{ head::fonts() }}

     

       32
       +
               {%- endblock fonts -%}

     

       33
       +
       

     

       34
       +
               {%- block css -%}

     

       35
       +
                   {{ head::styling() }}

     

       36
       +
               {%- endblock css -%}

     

       37
       +
       

     

       38
       +
               {%- block favicon -%}

     

       39
       +
                   {{ head::favicon() }}

     

       40
       +
               {%- endblock favicon -%}

     

       41
       +
       

     

       42
       +
               {%- block rss -%}

     

       43
       +
                   {{ head::rss() }}

     

       44
       +
               {%- endblock rss -%}

     

       45
       +
       

     

       46
       +
               {%- block math -%}

     

       47
       +
               {%- endblock math -%}

     

       48
       +
           </head>

     

       49
       +
           <body>

     

       50
       +
               {#

     

       51
       +
               "container full" when width == True, regardless of center

     

       52
       +
               "container center" when only center == True

     

       53
       +
               "container" when both false.

     

       54
       +
               #}

     

       55
       +
               {%- if config.extra.full_width -%}

     

       56
       +
                   {%- set container = "container full" -%}

     

       57
       +
               {%- elif config.extra.center -%}

     

       58
       +
                   {%- set container = "container center" -%}

     

       59
       +
               {%- else -%}

     

       60
       +
                   {%- set container = "container" -%}

     

       61
       +
               {%- endif -%}

     

       62
       +
       

     

       63
       +
               <div class="{{ container }}">

     

       64
       +
                   {%- block header -%}

     

       65
       +
                       {{ header::header() }}

     

       66
       +
                   {%- endblock header -%}

     

       67
       +
                   <div class="content">

     

       68
       +
                       {%-  block main -%}

     

       69
       +
                           {{ lists::list_pages() }}

     

       70
       +
                       {%- endblock main -%}

     

       71
       +
                   </div>

     

       72
       +
                   {#-

     

       73
       +
                   I keep pagination out of list, unlike Terminal, because I don't

     

       74
       +
                   like how the pagination buttons move with the width of the content

     

       75
       +
                   div.

     

       76
       +
                   -#}

     

       77
       +
                   {%- block pagination -%}

     

       78
       +
                       {{ pagination::paginate() }}

     

       79
       +
                   {%- endblock pagination -%}

     

       80
       +
       

     

       81
       +
                   {%- block footer -%}

     

       82
       +
                       <footer class="footer">

     

       83
       +
                           <div class="footer__inner">

     

       84
       +
                               {%- block copyright -%}

     

       85
       +
                                   {{ footer::copyright() }}

     

       86
       +
                               {%- endblock copyright -%}

     

       87
       +
       

     

       88
       +
                               {%- block script -%}

     

       89
       +
                                   {{ footer::script() }}

     

       90
       +
                               {%- endblock script -%}

     

       91
       +
                           </div>

     

       92
       +
                           {{ extended_footer::extended_footer() }}

     

       93
       +
                       </footer>

     

       94
       +
                   {%- endblock footer -%}

     

       95
       +
               </div>

     

       96
       +
           </body>

     

       97
       +
       </html>

+30

themes/zerm/templates/macros/comments.html

···

       1
       +
       {% macro comments() %}

     

       2
       +
           {% if config.extra.disqus.enabled is defined and config.extra.disqus.enabled == true %}

     

       3
       +
               {{ comments::disqus() }}

     

       4
       +
           {% endif %}

     

       5
       +
       {% endmacro comments %}

     

       6
       +
       

     

       7
       +
       

     

       8
       +
       {% macro disqus() %}

     

       9
       +
       

     

       10
       +
           <div id="disqus_thread"></div>

     

       11
       +
           <script>

     

       12
       +
               /**

     

       13
       +
               *  RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.

     

       14
       +
               *  LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT: https://disqus.com/admin/universalcode/#configuration-variables    */

     

       15
       +
               

     

       16
       +
               var disqus_config = function () {

     

       17
       +
                   this.page.url = '{{ page.permalink | safe }}';  // Replace PAGE_URL with your page's canonical URL variable

     

       18
       +
                   this.page.identifier = '{{ page.permalink | safe }}'; // Replace PAGE_IDENTIFIER with your page's unique identifier variable

     

       19
       +
               };

     

       20
       +
               

     

       21
       +
               (function() { // DON'T EDIT BELOW THIS LINE

     

       22
       +
               var d = document, s = d.createElement('script');

     

       23
       +
               s.src = 'https://{{config.extra.disqus.short_name}}.disqus.com/embed.js';

     

       24
       +
               s.setAttribute('data-timestamp', +new Date());

     

       25
       +
               (d.head || d.body).appendChild(s);

     

       26
       +
               })();

     

       27
       +
           </script>

     

       28
       +
           <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>

     

       29
       +
       

     

       30
       +
       {% endmacro disqus %}

themes/zerm/templates/macros/extended_footer.html

···

       1
       +
       {% macro extended_footer() %}

     

       2
       +
       {% endmacro extended_footer %}

themes/zerm/templates/macros/extended_header.html

···

       1
       +
       {% macro extended_header() %}

     

       2
       +
       {% endmacro extended_header %}

+14

themes/zerm/templates/macros/footer.html

···

       1
       +
       {% macro copyright() %}

     

       2
       +
           {%- if config.extra.copyright -%}

     

       3
       +
               <div class="copyright copyright--user">{{ config.extra.copyright | safe }}</div>

     

       4
       +
           {%- else -%}

     

       5
       +
               <div class="copyright">

     

       6
       +
                   <span>© {{ now() | date(format="%Y") }} <a href="https://github.com/ejmg/zerm">zerm</a> :: Powered by <a href="https://www.getzola.org/">Zola</a></span>

     

       7
       +
                   <span>:: Theme made by <a href="https://github.com/ejmg">ejmg</a></span>

     

       8
       +
               </div>

     

       9
       +
           {%- endif -%}

     

       10
       +
       {% endmacro copyright %}

     

       11
       +
       

     

       12
       +
       {% macro script() %}

     

       13
       +
           <script type="text/javascript" src="{{ get_url(path="assets/js/main.js") }}"></script>

     

       14
       +
       {% endmacro script %}

+84

themes/zerm/templates/macros/head.html

···

       1
       +
       {#- TODO:

     

       2
       +
           - [x] add rss

     

       3
       +
           - [x] favicons

     

       4
       +
           - [x] media preview

     

       5
       +
           - [ ] twitter

     

       6
       +
           - [ ] maybe google adsense

     

       7
       +
           -#}

     

       8
       +
           

     

       9
       +
       {% macro fonts() %}

     

       10
       +
           <link rel="preload" href="{{ get_url(path="/assets/fonts/FiraCode-Regular.woff2") }}" as="font" type="font/woff2" crossorigin="anonymous">

     

       11
       +
           <link rel="preload" href="{{ get_url(path="/assets/fonts/FiraCode-Bold.woff2") }}" as="font" type="font/woff2" crossorigin="anonymous">

     

       12
       +
       {% endmacro fonts %}

     

       13
       +
       

     

       14
       +
       {% macro styling() %}

     

       15
       +
           <link rel="stylesheet" href="{{ get_url(path="style.css", cachebust=true) }}">

     

       16
       +
           {% if config.extra.theme_color != "orange" -%}

     

       17
       +
               {% set color = "color/" ~ config.extra.theme_color ~ ".css" -%}

     

       18
       +
               <link rel="stylesheet" href="{{ get_url(path=color, cachebust=true) }}">

     

       19
       +
           {%- else -%}

     

       20
       +
               <link rel="stylesheet" href=" {{ get_url(path="color/orange.css", cachebust=true) }}">

     

       21
       +
           {% endif %}

     

       22
       +
           {%- if config.extra.custom_css is defined -%}

     

       23
       +
               <link rel="stylesheet" href="{{ get_url(path="custom.css", cachebust=true) }}">

     

       24
       +
           {% endif %}

     

       25
       +
       {% endmacro styling %}

     

       26
       +
       

     

       27
       +
       {% macro favicon() %}

     

       28
       +
           {%- if config.extra.favicon is defined -%}

     

       29
       +
               <link rel="shortcut icon" href="{{ get_url(path=config.extra.favicon) }}" type="image/x-icon" />

     

       30
       +
           {%- endif -%}

     

       31
       +
       {% endmacro favicon %}

     

       32
       +
       

     

       33
       +
       {% macro rss() %}

     

       34
       +
           {%- if config.generate_feed -%}

     

       35
       +
               <link rel="alternate" type={% if config.feed_filename == "atom.xml" %}"application/atom+xml"{% else %}"application/rss+xml"{% endif %} title="{{ config.title }} RSS" href="{{ get_url(path=config.feed_filename) }}">

     

       36
       +
           {%- endif -%}

     

       37
       +
       {% endmacro rss %}

     

       38
       +
       

     

       39
       +
       {% macro general_meta() %}

     

       40
       +
           <meta http-equiv="content-type" content="text/html; charset=utf-8">

     

       41
       +
           <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">

     

       42
       +
           {%- if page.title -%}

     

       43
       +
               <meta name="description" content="{{ config.description }} {{ page.title }} {{ page.description }}"/>

     

       44
       +
           {%- else -%}

     

       45
       +
               <meta name="description" content="{{ config.description }}"/>

     

       46
       +
           {%- endif -%}

     

       47
       +
       

     

       48
       +
           {%- if page.taxonomies.tags or page.taxonomies.categories -%}

     

       49
       +
               <meta name="keywords" content="

     

       50
       +
               {%- if page.taxonomies.categories -%}

     

       51
       +
                   {%- for cat in page.taxonomies.categories -%}

     

       52
       +
                           {{ cat }}, {% endfor -%}

     

       53
       +
               {%- endif -%}

     

       54
       +
       

     

       55
       +
               {%- if page.taxonomies.tags -%}

     

       56
       +
                   {%- for tag in page.taxonomies.tags -%}

     

       57
       +
                       {%- if loop.last -%}

     

       58
       +
                           {{ tag }}

     

       59
       +
                       {%- else -%}

     

       60
       +
                           {{ tag }}, {% endif -%}

     

       61
       +
                   {%- endfor -%}

     

       62
       +
               {%- endif -%}

     

       63
       +
               " />

     

       64
       +
           {%- endif -%}

     

       65
       +
       {% endmacro general_meta %}

     

       66
       +
       

     

       67
       +
       {% macro katex() %}

     

       68
       +
       {% if config.extra.enable_katex %}

     

       69
       +
         <link rel="stylesheet" href="{{ get_url(path="assets/katex/katex.min.css") }}">

     

       70
       +
       

     

       71
       +
         <script defer type="text/javascript" src="{{ get_url(path="assets/katex/katex.min.js") | safe }}"></script>

     

       72
       +
         <script defer type="text/javascript" src="{{ get_url(path="assets/katex/mathtex-script-type.min.js") | safe }}"></script>

     

       73
       +
       

     

       74
       +
         <script defer src="{{ get_url(path="assets/katex/auto-render.min.js") | safe }}"

     

       75
       +
           onload="renderMathInElement(document.body, {

     

       76
       +
       				delimiters: [

     

       77
       +
       					{left: '$$', right: '$$', display: true},

     

       78
       +
       					{left: '$', right: '$', display: false},

     

       79
       +
       					{left: '\\(', right: '\\)', display: false},

     

       80
       +
       					{left: '\\[', right: '\\]', display: true}

     

       81
       +
       				]

     

       82
       +
       			});"></script>

     

       83
       +
       {% endif %}

     

       84
       +
       {% endmacro katek %}

+16

themes/zerm/templates/macros/header.html

···

       1
       +
       {% macro header() %}

     

       2
       +
       <header class="header">

     

       3
       +
           <div class="header__inner">

     

       4
       +
               <div class="header__logo">

     

       5
       +
                   {{ logo::logo() }}

     

       6
       +
               </div>

     

       7
       +
               <div class="menu-trigger">menu</div>

     

       8
       +
           </div>

     

       9
       +
           {# Check if there are menu items to render, yes if > 0 #}

     

       10
       +
           {%- set num = config.extra.main_menu | length -%}

     

       11
       +
           {% if num > 0 -%}

     

       12
       +
               {{ menu::menu() }}

     

       13
       +
           {% endif -%}

     

       14
       +
       </header>

     

       15
       +
       {% endmacro header %}

     

       16
       +

+39

themes/zerm/templates/macros/lists.html

···

       1
       +
       {% macro list_pages() %}

     

       2
       +
       <section class="posts">

     

       3
       +
           

     

       4
       +
           {%- for page in paginator.pages -%}

     

       5
       +
           

     

       6
       +
           <div class="post on-list">

     

       7
       +
               <header>

     

       8
       +
                   <h1 class="post-title">

     

       9
       +
                       <a href="{{ page.permalink }}">{{ page.title }}</a>

     

       10
       +
                   </h1>

     

       11
       +
               </header>

     

       12
       +
               

     

       13
       +
               

     

       14
       +
               {{ posts::meta(page=page, author=config.extra.show_author) }}

     

       15
       +
               

     

       16
       +
               {#-                NOTE              -#}

     

       17
       +
               {#- --------------------------------  -#}

     

       18
       +
               {#- Skipping the Cover page implementation. Not included/covered for now. -#}

     

       19
       +
       

     

       20
       +
               <div class="post-content">

     

       21
       +
                   {%  if page.description -%}

     

       22
       +
                   {{ page.description }}

     

       23
       +
                   {#- end if-check for description -#}

     

       24
       +
                   {%  elif page.summary -%}

     

       25
       +
                   {{ page.summary | safe }}

     

       26
       +
                   {%  endif -%}

     

       27
       +
               </div>

     

       28
       +
               {% if page.description or page.summary -%}

     

       29
       +
               <div>

     

       30
       +
                   <a class="read-more button" href="{{ page.permalink }}">{{ config.extra.read_more }} →</a>

     

       31
       +
               </div>

     

       32
       +
               {% endif -%}

     

       33
       +
           </div>

     

       34
       +
           {# End of pagination for-loop #}

     

       35
       +
           {%- endfor -%}

     

       36
       +
           {#- I don't put pagination here like Terminal does. I don't like how

     

       37
       +
           the buttons move with the size of post entries in the content div. -#}

     

       38
       +
       </section>

     

       39
       +
       {% endmacro list_pages %}

themes/zerm/templates/macros/logo.html

···

       1
       +
       {%- macro logo() -%}

     

       2
       +
       <a href="{%- if config.extra.logo_home_link -%}{{ config.extra.logo_home_link }}{%- else -%}{{ config.base_url }}{%- endif -%}">

     

       3
       +
           <div class="logo">

     

       4
       +
               {{config.extra.logo_text | default(value="Terminal") }}

     

       5
       +
           </div>

     

       6
       +
       </a>

     

       7
       +
       {%- endmacro logo -%}

+58

themes/zerm/templates/macros/menu.html

···

       1
       +
       {% macro menu() %}

     

       2
       +
           <nav class="menu">

     

       3
       +
               <ul class="menu__inner menu__inner--desktop">

     

       4
       +
                   {# 

     

       5
       +
                   I am almost certain this check isn't necessary, that it will always

     

       6
       +
                   return true, but the only alternative I can think of is the case where

     

       7
       +
                   this config value simply doesn't exist (null)? IDK, just copying from

     

       8
       +
                   original implementation for now.

     

       9
       +
                   #}

     

       10
       +
                   {% if config.extra.show_menu_items is defined -%}

     

       11
       +
                       {% for menu_item in config.extra.main_menu | slice(end=config.extra.show_menu_items) -%}

     

       12
       +
                           {# 

     

       13
       +
                           Original theme has sub-children checks on main-menu, not worrying about that here.

     

       14
       +
                           #}

     

       15
       +
                           <li>

     

       16
       +
                               <a href="{{ menu::get_link(item=menu_item) }}">{{ menu_item.name }}</a>

     

       17
       +
                           </li>

     

       18
       +
                       {% endfor -%}

     

       19
       +
       

     

       20
       +
                       {%- set main_len = config.extra.main_menu | length -%}

     

       21
       +
                       {%- set show_len = config.extra.show_menu_items -%}

     

       22
       +
       

     

       23
       +
                       {%- if main_len > show_len -%}

     

       24
       +
                           <ul class="menu__sub-inner">

     

       25
       +
                               <li class="menu__sub-inner-more-trigger">{{ config.extra.menu_more }} ▾</li>

     

       26
       +
                               <ul class="menu__sub-inner-more hidden">

     

       27
       +
                                   {{ menu::items(menu=config.extra.main_menu | slice(start=config.extra.show_menu_items)) }}

     

       28
       +
                               </ul>

     

       29
       +
                           </ul>

     

       30
       +
                       {%- endif -%}

     

       31
       +
                       {# Continues the original if-check at top of file for show_menu_items #}

     

       32
       +
                   {% else -%}

     

       33
       +
                       {{ menu::items(menu=config.extra.main_menu) }}

     

       34
       +
                   {%- endif -%}

     

       35
       +
               </ul>

     

       36
       +
       

     

       37
       +
               <ul class="menu__inner menu__inner--mobile">

     

       38
       +
                   {{ menu::items(menu=config.extra.main_menu) }}

     

       39
       +
               </ul>

     

       40
       +
           </nav>

     

       41
       +
       {% endmacro menu %}

     

       42
       +
       

     

       43
       +
       {% macro items(menu) %}

     

       44
       +
           {%- for menu_item in menu -%}

     

       45
       +
               {# skipping sub-child check #}

     

       46
       +
               <li>

     

       47
       +
                   <a href="{{ menu::get_link(item=menu_item) }}">{{ menu_item.name }}</a>

     

       48
       +
               </li>

     

       49
       +
           {%- endfor-%}

     

       50
       +
       {% endmacro items %}

     

       51
       +
       

     

       52
       +
       {% macro get_link(item) %}

     

       53
       +
           {% if item.external is defined and item.external == true %}

     

       54
       +
               {{ item.url }}

     

       55
       +
           {% else %}

     

       56
       +
               {{ get_url(path=item.url) }}

     

       57
       +
           {% endif %}

     

       58
       +
       {% endmacro get_link %}

+100

themes/zerm/templates/macros/posts.html

···

       1
       +
       {% macro section_meta(section, author) %}

     

       2
       +
           <div class="post-meta">

     

       3
       +
               <span class="post-date">

     

       4
       +
       

     

       5
       +
                   {%- if section.extra["date"] -%}

     

       6
       +
                       {{ section.extra["date"] | date(format="%Y.%m.%d") }}

     

       7
       +
                       {# end of section.date if-check #}

     

       8
       +
                   {%- endif -%}

     

       9
       +
               </span>

     

       10
       +
       

     

       11
       +
               <span class="post-author">

     

       12
       +
                   {%- if author -%}

     

       13
       +
                       {{ utils::author(page=section) }}

     

       14
       +
                   {%- endif -%}

     

       15
       +
               </span>

     

       16
       +
           </div>

     

       17
       +
       {% endmacro section_meta %}

     

       18
       +
       

     

       19
       +
       {% macro langs(page) %}

     

       20
       +
           {% if page.translations | length > 1 %}

     

       21
       +
           <div class="post-langs" style="opacity: .5;">

     

       22
       +
             <span>Translations: </span>{# TODO translate the span content too #}

     

       23
       +
             {% for translated in page.translations %}

     

       24
       +
             <a href="{{ translated.permalink }}">{{ translated.lang }}</a>

     

       25
       +
             {% endfor %}

     

       26
       +
           </div>

     

       27
       +
           {% endif %}

     

       28
       +
       {% endmacro langs %}

     

       29
       +
       

     

       30
       +
       {% macro meta(page, author) %}

     

       31
       +
           <div class="post-meta">

     

       32
       +
               <span class="post-date">

     

       33
       +
                   {%- if page.date -%}

     

       34
       +
                       {{ page.date | date(format="%Y.%m.%d") }}

     

       35
       +
                       {# end of page.date if-check #}

     

       36
       +
                   {%- endif -%}

     

       37
       +
       

     

       38
       +
                   {%- if page.updated -%}

     

       39
       +
                       [Updated: {{ page.updated | date(format="%Y.%m.%d") }}]

     

       40
       +
                       {# end of page.updated if-check #}

     

       41
       +
                   {%- endif -%}

     

       42
       +
               </span>

     

       43
       +
       

     

       44
       +
               <span class="post-author">

     

       45
       +
                   {%- if author -%}

     

       46
       +
                       {{ utils::author(page=page) }}

     

       47
       +
                   {%- endif -%}

     

       48
       +
               </span>

     

       49
       +
       

     

       50
       +
               {{  posts::taxonomies(taxonomy=page.taxonomies,

     

       51
       +
                   disp_cat=config.extra.show_categories,

     

       52
       +
                   disp_tag=config.extra.show_tags) }}

     

       53
       +
           </div>

     

       54
       +
       {% endmacro meta %}

     

       55
       +
       

     

       56
       +
       {% macro taxonomies(taxonomy, disp_cat, disp_tag) %}

     

       57
       +
       

     

       58
       +
           {% if disp_cat and disp_tag -%}

     

       59
       +
               {% if taxonomy.categories -%}

     

       60
       +
                   {{ posts::categories(categories=taxonomy.categories) }}

     

       61
       +
                   {# end if-check for categories #}

     

       62
       +
               {%- endif -%}

     

       63
       +
       

     

       64
       +
               {% if taxonomy.tags -%}

     

       65
       +
                   {{ posts::tags(tags=taxonomy.tags) }}

     

       66
       +
                   {# end if-check for tags #}

     

       67
       +
               {% endif -%}

     

       68
       +
           {% elif disp_cat -%}

     

       69
       +
               {% if taxonomy.categories-%}

     

       70
       +
                   {{ posts::categories(categories=taxonomy.categories) }}

     

       71
       +
                   {# end if-check for categories #}

     

       72
       +
               {% endif -%}

     

       73
       +
           {% elif disp_tag -%}

     

       74
       +
               {% if taxonomy.tags -%}

     

       75
       +
                   {{ posts::tags(tags=taxonomy.tags) }}

     

       76
       +
                   {# end if-check for tags #}

     

       77
       +
               {% endif -%}

     

       78
       +
               {# end if-check for BOTH disp bools #}

     

       79
       +
           {% endif -%}

     

       80
       +
       {% endmacro taxonomies %}

     

       81
       +
       

     

       82
       +
       {% macro categories(categories) %}

     

       83
       +
           :: {

     

       84
       +
           {%- for cat in categories -%}

     

       85
       +
               {%- if loop.last -%}

     

       86
       +
                   <a href="{{ get_taxonomy_url(kind="categories", name=cat ) }}">{{ cat }}</a>

     

       87
       +
               {%- else -%}

     

       88
       +
                   <a href="{{ get_taxonomy_url(kind="categories", name=cat ) }}">{{ cat }}</a>,

     

       89
       +
                   {# end of if-check for whether last item or not #}

     

       90
       +
               {%- endif -%}

     

       91
       +
           {%- endfor -%}} {# <--- NOTE: OPEN CURLY BRACE #}

     

       92
       +
       {% endmacro categories %}

     

       93
       +
       

     

       94
       +
       {% macro tags(tags) %}

     

       95
       +
           ::

     

       96
       +
           {% for tag in tags -%}

     

       97
       +
               #<a href="{{get_taxonomy_url(kind="tags", name=tag )}}">{{ tag }}</a>

     

       98
       +
               {# end of tags for-loop #}

     

       99
       +
           {% endfor -%}

     

       100
       +
       {% endmacro tags %}

+61

themes/zerm/templates/macros/toc.html

···

       1
       +
       {% macro toc (t) %}

     

       2
       +
       {% if t %}

     

       3
       +
       <div class="toc" id="nav-container">

     

       4
       +
       	<p class="toc-head">Table of Contents</p>

     

       5
       +
       		<div id="nav-content" >

     

       6
       +
       		<ul>

     

       7
       +
       		{% for h1 in page.toc %}

     

       8
       +
       			<li>

     

       9
       +
       				<a href="{{ h1.permalink | safe }}">{{ h1.title }}</a>

     

       10
       +
       				{% if h1.children %}

     

       11
       +
       					<ul>

     

       12
       +
       						{% for h2 in h1.children %}

     

       13
       +
       							<li>

     

       14
       +
       								<a href="{{ h2.permalink | safe }}">{{ h2.title }}</a>

     

       15
       +
       							</li>

     

       16
       +
       							{% if h2.children %}

     

       17
       +
       								<ul>

     

       18
       +
       								{% for h3 in h2.children %}

     

       19
       +
       									<li>

     

       20
       +
       										<a href="{{ h3.permalink | safe }}">{{ h3.title }}</a>

     

       21
       +
       										{% if h3.children %}

     

       22
       +
       											<ul>

     

       23
       +
       												{% for h4 in h3.children %}

     

       24
       +
       													<li>

     

       25
       +
       														<a href="{{ h4.permalink | safe }}">{{ h4.title }}</a>

     

       26
       +
       													</li>

     

       27
       +
       													{% if h4.children %}

     

       28
       +
       														<ul>

     

       29
       +
       															{% for h5 in h4.children %}

     

       30
       +
       																<li>

     

       31
       +
       																	<a href="{{ h5.permalink | safe }}">{{ h5.title }}</a>

     

       32
       +
       																	{% if h5.children %}

     

       33
       +
       																		<ul>

     

       34
       +
       																		{% for h6 in h5.children %}

     

       35
       +
       																			<li>

     

       36
       +
       																				<a href="{{ h5.permalink | safe }}">{{ h6.title }}</a>

     

       37
       +
       																			</li>

     

       38
       +
       																		{% endfor %}

     

       39
       +
       																		</ul>

     

       40
       +
       																	{% endif %}

     

       41
       +
       																</li>

     

       42
       +
       															{% endfor %}

     

       43
       +
       														</ul>

     

       44
       +
       													{% endif %}

     

       45
       +
       												{% endfor %}

     

       46
       +
       											</ul>

     

       47
       +
       										{% endif %}

     

       48
       +
       									</li>

     

       49
       +
       								{% endfor %}

     

       50
       +
       								</ul>

     

       51
       +
       							{% endif %}

     

       52
       +
       						{% endfor %}

     

       53
       +
       					</ul>

     

       54
       +
       				{% endif %}

     

       55
       +
       			</li>

     

       56
       +
       		{% endfor %}

     

       57
       +
       		</ul>

     

       58
       +
       		</div>

     

       59
       +
       </div>

     

       60
       +
       {% endif %}

     

       61
       +
       {% endmacro %}

themes/zerm/templates/macros/utils.html

···

       1
       +
       {% macro author(page) %}

     

       2
       +
           ::

     

       3
       +
           {% if page.extra.author -%}

     

       4
       +
               {{ page.extra.author }}

     

       5
       +
           {%- else -%}    

     

       6
       +
               {{ config.extra.author }}

     

       7
       +
           {%- endif -%}

     

       8
       +
       {%- endmacro author-%}

+41

themes/zerm/templates/page.html

···

       1
       +
       {% import "macros/head.html" as head -%}

     

       2
       +
       {% import "macros/toc.html" as toc -%}

     

       3
       +
       {% extends "index.html" -%}

     

       4
       +
       

     

       5
       +
       {%- block math -%}

     

       6
       +
         {% if page.extra.math %}

     

       7
       +
         {{ head::katex() }}

     

       8
       +
         {% endif %}

     

       9
       +
       {%- endblock math -%}

     

       10
       +
       

     

       11
       +
       {%- block title %}

     

       12
       +
           <title>{{ page.title }} - {{  config.extra.author }}</title>

     

       13
       +
           {# TODO: make some kind of social media linking, i guess? #}

     

       14
       +
           {#%- include "snippets/social.html" %#}

     

       15
       +
       {%- endblock title -%}

     

       16
       +
       

     

       17
       +
       {%- block main -%}

     

       18
       +
           <article class="post">

     

       19
       +
               <header>

     

       20
       +
                   <h1 class="post-title">

     

       21
       +
                       <a href="{{ page.permalink  }}">{{ page.title }}</a>

     

       22
       +
                   </h1>

     

       23
       +
                   {{ posts::meta(page=page, author=config.extra.show_author) }}

     

       24
       +
                   {{ posts::langs(page=page) }}

     

       25
       +
       

     

       26
       +
                   {%- block ToC -%}

     

       27
       +
                       {%- if page.extra.ToC or config.extra.ToC -%}

     

       28
       +
                           {{ toc::toc(t=page.toc) }}

     

       29
       +
                       {%- endif -%}

     

       30
       +
                   {%- endblock ToC -%}

     

       31
       +
               </header>

     

       32
       +
       

     

       33
       +
               {#- Skipping logic for cover as was in original Terminal theme -#}

     

       34
       +
       

     

       35
       +
               {{ page.content | safe }}

     

       36
       +
       

     

       37
       +
               {{ comments::comments() }}

     

       38
       +
               {# TODO: Decide if any sort of commenting functionality is desired? #}

     

       39
       +
               {#%- include "snippets/comments.html"  -%#}

     

       40
       +
           </article>

     

       41
       +
       {%- endblock main -%}

+24

themes/zerm/templates/section.html

···

       1
       +
       {% extends "index.html" -%}

     

       2
       +
       

     

       3
       +
       {%- block title %}

     

       4
       +
           <title>{{ section.title }} - {{ config.extra.author }}</title>

     

       5
       +
           {# TODO: make some kind of social media linking, i guess? #}

     

       6
       +
           {#%- include "snippets/social.html" %#}

     

       7
       +
       {%- endblock title -%}

     

       8
       +
       

     

       9
       +
       {%- block main -%}

     

       10
       +
           <article class="post">

     

       11
       +
               <header>

     

       12
       +
                   <h1 class="post-title">

     

       13
       +
                       <a href="{{ section.permalink  }}">{{ section.title }}</a>

     

       14
       +
                   </h1>

     

       15
       +
                   {{ posts::section_meta(section=section, author=config.extra.show_author) }}

     

       16
       +
               </header>

     

       17
       +
       

     

       18
       +
               {#- Skipping logic for cover as was in original Terminal theme -#}

     

       19
       +
       

     

       20
       +
                   {{ section.content | safe }}

     

       21
       +
               {# TODO: Decide if any sort of commenting functionality is desired? #}

     

       22
       +
               {#%- include "snippets/comments.html"  -%#}

     

       23
       +
           </article>

     

       24
       +
       {%- endblock main -%}

+12

themes/zerm/templates/static.html

···

       1
       +
       {% extends "index.html" %}

     

       2
       +
       

     

       3
       +
       {% block header %}

     

       4
       +
           <title>{{ page.title }} | elias </title>

     

       5
       +
       {% endblock header %}

     

       6
       +
       

     

       7
       +
       {% block content %}

     

       8
       +
           <article>

     

       9
       +
               <h1>{{ page.title }}</h1>

     

       10
       +
               {{ page.content | safe }}

     

       11
       +
           </article>

     

       12
       +
       {% endblock content %}

+18

themes/zerm/templates/tags/list.html

···

       1
       +
       {% extends "index.html" %}

     

       2
       +
       {%- block main -%}

     

       3
       +
       <div class="post">

     

       4
       +
       

     

       5
       +
           <h1 class="post-title">#tags</h1>

     

       6
       +
           <ul>

     

       7
       +
               {%- for term in terms -%}

     

       8
       +
                   <li class="tag-list">

     

       9
       +
                       <a href="{{ get_taxonomy_url(kind="tags", name=term.name) }}">#{{ term.name }}</a>

     

       10
       +
                       ({{ term.pages | length }} post{{ term.pages | length | pluralize}})

     

       11
       +
                   </li>

     

       12
       +
                   {# End of pagination for-loop #}

     

       13
       +
               {%- endfor -%}

     

       14
       +
               {#- I don't put pagination here like Terminal does. I don't like how

     

       15
       +
               the buttons move with the size of post entries in the content div. -#}

     

       16
       +
           </ul>

     

       17
       +
       </div>

     

       18
       +
       {%- endblock main -%}

+23

themes/zerm/templates/tags/single.html

···

       1
       +
       {%- extends "index.html"-%}

     

       2
       +
       {%- block main-%}

     

       3
       +
           <div class="post">

     

       4
       +
               <h1 class="post-title">

     

       5
       +
                   tags ∋ #{{ term.name }}

     

       6
       +
                   ({{ term.pages | length }} post{{ term.pages | length | pluralize}})

     

       7
       +
               </h1>

     

       8
       +
       

     

       9
       +
               <ul>

     

       10
       +
                   {%- for post in term.pages -%}

     

       11
       +
                       <li class="tag-list">

     

       12
       +
                           {{ post.date | date(format="%Y.%m.%d") }}

     

       13
       +
                           :: <a href="{{ post.permalink }}">{{ post.title }}</a>

     

       14
       +
                           :: {% for tag in post.taxonomies["tags"] -%} <a href="{%- set _tag = get_taxonomy_url(kind="tags", name=tag) -%}{{ _tag }}">#{{ tag }}</a> {% endfor %}

     

       15
       +
                       </li>

     

       16
       +
                       {# End of pagination for-loop #}

     

       17
       +
                   {%- endfor -%}

     

       18
       +
                   {#- I don't put pagination here like Terminal does. I don't like how

     

       19
       +
                   the buttons move with the size of post entries in the content div. -#}

     

       20
       +
               </ul>

     

       21
       +
       

     

       22
       +
       </div>

     

       23
       +
       {%- endblock main-%}

+26

themes/zerm/theme.toml

···

       1
       +
       name = "zerm"

     

       2
       +
       description = "A minimalistic and dark theme based on Radek Kozieł's theme for Hugo"

     

       3
       +
       license = "MIT"

     

       4
       +
       homepage = "https://github.com/ejmg/zerm"

     

       5
       +
       # The minimum version of Zola required

     

       6
       +
       min_version = "0.8.0"

     

       7
       +
       # An optional live demo URL

     

       8
       +
       demo = "https://zerm.ejmg.now.sh/"

     

       9
       +
       

     

       10
       +
       # Any variable there can be overriden in the end user `config.toml`

     

       11
       +
       # You don't need to prefix variables by the theme name but as this will

     

       12
       +
       # be merged with user data, some kind of prefix or nesting is preferable

     

       13
       +
       # Use snake_casing to be consistent with the rest of Zola

     

       14
       +
       [extra]

     

       15
       +
       

     

       16
       +
       # The theme author info: you!

     

       17
       +
       [author]

     

       18
       +
       name = "elias julian marko garcia"

     

       19
       +
       homepage = "https://github.com/ejmg"

     

       20
       +
       

     

       21
       +
       # If this is porting a theme from another static site engine, provide

     

       22
       +
       # the info of the original author here

     

       23
       +
       [original]

     

       24
       +
       author =  "Radek Kozieł"

     

       25
       +
       homepage = "https://radoslawkoziel.pl/"

     

       26
       +
       repo = "https://github.com/panr/hugo-theme-terminal"

themes/zerm/zerm-preview.png

This is a binary file and will not be displayed.

Compare changes