Improve documentation.

Author: echasnovski

_scripts/mini_nvim.lua

@@ -190,6 +190,33 @@ local add_help_syntax = function(lines, tags)
   reflow(lines)
 end
 
+local adjust_toc = function(lines)
+  -- Transform Table Of Contents (entries like "aaa .... bbb ... ccc") into
+  -- a markdown table with each part as a separate column.
+  for i, l in iter_noncode(lines) do
+    local is_toc_line = l:find('%s+%.%.%.+%s+') ~= nil
+    if is_toc_line then
+      -- Allow more than one column
+      local line, n_repl = vim.trim(l):gsub('%s+%.%.%.+%s+', ' | ')
+      lines[i] = '| ' .. line .. ' |'
+      local n_col = n_repl + 1
+
+      -- Prepend first TOC item with a (possibly crudely detected) header
+      local header_parts = vim.split(vim.trim(lines[i - 1]), '   +')
+      local is_blank_prev_line = header_parts[1] == '' and header_parts[2] == nil
+      if is_blank_prev_line or #header_parts == n_col then
+        header_parts = is_blank_prev_line and vim.fn['repeat']({ '' }, n_col) or header_parts
+        local header = '| ' .. table.concat(header_parts, ' | ') .. ' |'
+        -- Assume right most column is a link, so right align it.
+        local separator = string.rep('|---', n_col) .. ':|'
+        lines[i - 1] = '\n' .. header .. '\n' .. separator
+      end
+    end
+  end
+
+  reflow(lines)
+end
+
 local adjust_alignment = function(lines)
   for i, l in iter_noncode(lines) do
     -- Transform center aligned signature or section "name"
@@ -256,19 +283,24 @@ local create_help = function()
   for file, _ in vim.fs.dir(help_path) do
     local basename = file:match('^(.+)%.txt$')
     if basename ~= nil then
-      local lines = vim.fn.readfile(vim.fs.joinpath(help_path, file))
+      local in_path = vim.fs.joinpath(help_path, file)
+      local lines = vim.fn.readfile(in_path)
 
       make_codeblocks(lines)
       adjust_rulers(lines)
       add_empty_lines(lines)
       add_help_syntax(lines, help_tags)
+      adjust_toc(lines)
       adjust_alignment(lines)
       add_hierarchical_heading_anchors(lines)
       add_source_note(lines)
       adjust_header_footer(lines, basename:gsub('%-', '.') .. ' documentation')
 
       local out_path = string.format('%s/%s.qmd', help_path, basename)
       vim.fn.writefile(lines, out_path)
+
+      -- Remove '*.txt' file, as it is not needed for the site
+      vim.fn.delete(in_path, '')
     end
   end
 end

blog/2025-03-07-update-mini-completion-snippet-support.qmd

@@ -15,6 +15,7 @@ The ['mini.completion'](https://github.com/nvim-mini/mini.nvim/blob/main/readmes
 The main improvement is (finally) added snippet support. That is, 'mini.completion' now can properly insert snippet completion entries. The main attention has gone into making it work with enabled ['mini.snippets'](https://github.com/nvim-mini/mini.nvim/blob/main/readmes/mini-snippets.md) module, but there is automated fallback to `vim.snippet` (on Neovim>=0.10).
 
 Other updates include:
+
 - Default mappings for scrolling down/up in both info/signature windows. Those are `<C-f>` and `<C-b>`, but can be configured (be careful with `<C-d>` and `<C-u>`, as they have special meaning during active built-in completion popup).
 - Significantly better highlighting in info/signature windows.
 - Support for `isIncomplete`, which means there will be automated update of completion list on the next key press if initial response from LSP server did not contain all possible items.

index.qmd

@@ -18,6 +18,7 @@
 
 - <p style="font-size:1.5em"><b><a href="mini.nvim/index.html">mini.nvim</a></b></p>
     - [Modules](mini.nvim/index.md#modules)
+    - [Documentation](mini.nvim/doc/mini-nvim.qmd)
     - [Change log](mini.nvim/CHANGELOG.md)
 
 - <p style="font-size:1.5em"><b><a href="blog.html">Blog</a></b></p>

theme/brand-dark.yml

@@ -49,10 +49,10 @@ typography:
   monospace:
     family: monospace
   monospace-inline:
-    color: grey
+    color: cyan
     background-color: bg-2
   link:
-    color: cyan
+    color: fg-2
     decoration: underline
 
 defaults:
@@ -66,10 +66,13 @@ defaults:
         margin-top: 0em;
         margin-bottom: 0.5em;
       }
-      h2, h3, h4 {
-        margin-top: 1em;
-        margin-bottom: 0.25em;
-      }
+      h1 { font-size: 2em }
+      h2 { font-size: 1.8em; margin-top: 1em; margin-bottom: 0.25em; }
+      h3 { font-size: 1.6em; margin-top: 1em; margin-bottom: 0.25em; }
+      h4 { font-size: 1.4em; margin-top: 1em; margin-bottom: 0.25em; font-weight: normal }
+      h5 { font-size: 1.2em; font-weight: normal }
+      h6 { font-size: 1em; font-weight: normal }
+
       p pre code:not(.sourceCode),
       li pre code:not(.sourceCode),
       pre code:not(.sourceCode) {

theme/brand-light.yml

@@ -50,10 +50,10 @@ typography:
     family: monospace
     background-color: bg-2
   monospace-inline:
-    color: grey
+    color: yellow
     background-color: bg-2
   link:
-    color: yellow
+    color: fg-2
     decoration: underline
 
 defaults:
@@ -67,10 +67,13 @@ defaults:
         margin-top: 0em;
         margin-bottom: 0.5em;
       }
-      h2, h3, h4 {
-        margin-top: 1em;
-        margin-bottom: 0.25em;
-      }
+      h1 { font-size: 2em }
+      h2 { font-size: 1.8em; margin-top: 1em; margin-bottom: 0.25em; }
+      h3 { font-size: 1.6em; margin-top: 1em; margin-bottom: 0.25em; }
+      h4 { font-size: 1.4em; margin-top: 1em; margin-bottom: 0.25em; font-weight: normal }
+      h5 { font-size: 1.2em; font-weight: normal }
+      h6 { font-size: 1em; font-weight: normal }
+
       p pre code:not(.sourceCode),
       li pre code:not(.sourceCode),
       pre code:not(.sourceCode) {