Merge branch 'master' into warnings_as_errors

Author: eksperimental

.github/workflows/ci.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   mix_test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     env:
       MIX_ENV: test
     strategy:
@@ -17,13 +17,13 @@ jobs:
         include:
           - pair:
               elixir: "1.11"
-              otp: 21
+              otp: "21"
           - pair:
-              elixir: "1.13"
-              otp: 24
+              elixir: "1.14"
+              otp: "26"
             lint: lint
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - uses: erlef/setup-beam@v1
         with:
@@ -59,17 +59,14 @@ jobs:
     name: Check JS
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2.3.3
-      - name: Set up Node.js 10.x
-        uses: actions/setup-node@v1.4.4
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 10.10.0
+          node-version: 16
       - run: npm install --prefix assets
       - run: npm run --prefix assets lint
-
       - run: sudo apt-get install xvfb
-      - name: npm install, build, and test
-        run: |
+      - run: |
           xvfb-run --auto-servernum npm run --prefix assets test
         env:
           CI: true

CHANGELOG.md

@@ -1,5 +1,88 @@
 # Changelog
 
+## v0.29.4 (2023-03-29)
+
+  * Bug fixes
+    * Fix sidebar element with no children taking additional padding
+    * Fix elements being rendered too thick on macOS
+    * Fix rendering of HTML elements inside tooltips
+
+## v0.29.3 (2023-03-17)
+
+  * Enhancements
+    * Propagate `:since` metadata from modules
+    * Add support for MFAs and maps in `before_closing_body_tag` and `before_closing_head_tag`
+
+  * Bug fixes
+    * Improve font consistency across different OSes
+    * Keep language class on livebook output code block
+    * Ensure switches have higher precedence than config
+
+## v0.29.2 (2023-03-02)
+
+  * Enhancements
+    * Improvements to cheatsheets spacing
+    * Improvements to cheatsheets print
+    * Include sections of modules and extras in search suggestions
+    * Make sidebar links full-width and add hover states
+    * Improve clickable area of sidebar tabs
+    * Improve contrast on sidebar
+
+  * Bug fix
+    * Add media type for .license files for epub
+    * Fix overscroll on the sidebar
+    * Focus search input immediately after keyboard shortcut
+    * Don't attempt parsing code blocks that don't look like modules
+    * Fix visited link color in admonition blocks
+
+## v0.29.1 (2022-11-21)
+
+  * Enhancements
+    * Add optional function annotations
+    * Support media print on stylesheets
+    * Add download ePub link to footer
+    * Support extras for Erlang
+    * Add tooltip to functions on sidebar
+    * Disable spellcheck and autocorrect on search input
+
+  * Bug fix
+    * Special handle functions called `record/*` in Erlang
+
+  * Deprecations
+    * Rename `:groups_for_functions` to `:groups_for_docs`
+
+## v0.29.0 (2022-10-19)
+
+  * Enhancements
+    * Support cheatsheets as `.cheatmd` files
+
+  * Bug fix
+    * Collapse sidebar when resizing page even if stored in the session as opened
+
+## v0.28.6 (2022-10-13)
+
+  * Enhancements
+    * Add Elixir special punctuation ! and ? to natural sort
+    * Add night mode to settings pane
+    * Support --proglang in mix docs
+    * Save sidebar state per session
+    * Distinguish output code blocks in Livebooks
+
+  * Bug fixes
+    * Prevent sidebar button scrolling out of view
+    * Prevent unreadable text when using inline code with admonition headers
+
+## v0.28.5 (2022-08-18)
+
+  * Enhancements
+    * Do not preserve spaces from spec declaration in signature rendering
+    * Index hyphens in search
+    * Index `@` in search
+    * Change minimal package search length to 2
+
+  * Bug fixes
+    * Remove extra `term()` argument at start of `@macrocallback`
+
 ## v0.28.4 (2022-04-28)
 
   * Enhancements

Cheatsheet.cheatmd

@@ -0,0 +1,260 @@
+# Cheatsheet User Guide
+
+This document is a cheatsheet on how to use cheatsheets.
+Cheatsheets are Markdown files with the `.cheatmd` extension. You may also check the source of this document as a reference.
+
+## I'm a H2 title with 2 columns
+{: .col-2}
+
+### I'm a H3 title
+
+#### I'm a H4 title.
+
+And this is a paragraph.
+
+### Code
+
+```elixir
+# hello.exs
+defmodule Greeter do
+  def greet(name) do
+    message = "Hello, " <> name <> "!"
+    IO.puts message
+  end
+end
+
+Greeter.greet("world")
+```
+
+### Paragraphs
+
+Paragraphs are also supported and can quote `code`.
+
+Several paragraphs are visually distinct.
+
+### Lists
+
+- Element 1
+- Element 2
+- `piece of code`
+
+### Table
+
+#### Date (H4 header)
+
+| Example         | Output                 |
+| ---             | ---                    |
+| `%m/%d/%Y`      | `06/05/2013`           |
+| `%A, %B %e, %Y` | `Sunday, June 5, 2013` |
+| `%b %e %a`      | `Jun 5 Sun`            |
+
+## Variants
+{: .col-2}
+
+### Adding variants
+
+```
+## H2
+{: .col-2}
+
+### H3
+{: .list-6}
+
+* example 1
+* example 2
+```
+
+Variants customize how your cheatsheet looks like via Markdown's inline attribute notation.
+
+### Header variants
+
+#### H2
+
+| `.col-2` | two-columns |
+| `.col-3` | three-columns |
+| `.col-2-left` | two-columns (1/3 - 2/3) |
+
+#### H3
+
+| `.list-4` | four-columns for lists |
+| `.list-6` | six-columns for lists |
+
+## Code
+{: .col-3}
+
+### Code with headings
+
+#### index.ex
+
+```
+Path.join(["~", "foo"])
+"~/foo"
+```
+
+#### other.ex
+
+```
+Path.join(["foo"])
+"foo"
+```
+
+Code blocks can have headings.
+
+### Long lines
+
+```elixir
+defmodule MyTracer do
+  def trace({:remote_function, _meta, module, name, arity}, env) do
+    IO.puts "#{env.file}:#{env.line} #{inspect(module)}.#{name}/#{arity}"
+    :ok
+  end
+
+  def trace(_event, _env) do
+    :ok
+  end
+end
+```
+
+Long lines show scrollbars.
+
+### Line wrapping
+
+```elixir
+defmodule MyTracer do
+  def trace({:remote_function, _meta, module, name, arity}, env) do
+    IO.puts "#{env.file}:#{env.line} #{inspect(module)}.#{name}/#{arity}"
+    :ok
+  end
+
+  def trace(_event, _env) do
+    :ok
+  end
+end
+```
+{: .wrap}
+
+Add `wrap` to wrap long lines.
+
+## Lists
+{: .col-2}
+
+### Bullet lists
+
+- This is
+- a list
+- with a few items
+
+### Ordered lists
+
+1. I'm first;
+2. You are second;
+3. We are third;
+
+Here's an extra paragraph after the list.
+
+### With headings and code links
+
+#### Part 1
+
+- `is_atom/1`
+- `is_binary/1`
+- `is_number/1`
+
+#### Part 2
+
+- `length/1`
+- `elem/2`
+
+## List columns
+
+### Six columns
+{: .list-6}
+
+- One
+- Two
+- Three
+- Four
+- Five
+- Six
+- Seven
+- Eight
+- Nine
+- Ten
+- Eleven
+
+Add `{: .list-6}` after the H3 title to make large lists.
+
+### Four columns
+{: .list-4}
+
+- One
+- Two
+- Three
+- Four
+- Five
+- Six
+- Seven
+- Eight
+- Nine
+- Ten
+- Eleven
+
+Add `{: .list-4}` after the H3 title to make large lists.
+
+## Full page
+
+This is the default.
+
+## Half width
+{: .width-50}
+
+### I make tables look nicer
+
+#### Time
+
+| Example         | Output                 |
+| ---             | ---                    |
+| `%H:%M`         | `23:05`                |
+| `%I:%M %p`      | `11:05 PM`             |
+
+Add `{: .width-50}` after the H2 title to use only half width.
+
+## Column left reference
+{: .col-2-left}
+
+### One
+
+```elixir
+# hello.exs
+defmodule Greeter do
+  def greet(name) do
+    message = "Hello, " <> name <> "!"
+    IO.puts message
+  end
+end
+
+Greeter.greet("world")
+```
+
+### Two
+
+```elixir
+user = %{
+  name: "John",
+  city: "Melbourne"
+}
+```
+
+```elixir
+IO.puts "Hello, " <> user.name
+```
+
+### Three
+
+* Yet
+* Another
+* List
+
+### Four
+
+I'm a grid, with 1/3 - 2/3 width.