@@ -313,104 +313,109 @@ Example: `{ 1, 2, 3 }` @ 4 = 3.
313
313
314
314
HEADINGS *render-markdown-setup-headings*
315
315
316
- Icon: `headings` Highlight: `highlights.heading.backgrounds` &
317
- `highlights.heading.backgrounds` Style: N/A
318
-
319
- The icons replace the `#` characters in front of headings. The number of `#`
320
- characters in the heading determines the level of the heading. The level is
321
- used to index into the icon table using a cycle. The icon is left padded with
322
- spaces to fill the gap and hide any additional `#` . The level is also used to
323
- index into both highlights tables using a clamp. Both are applied to the icon
324
- and the background extends through the entire line.
316
+ - Icon: `headings`
317
+ - Highlight: `highlights.heading.backgrounds` & `highlights.heading.backgrounds`
318
+ - Style: N/A
319
+ - The icons replace the `#` characters in front of headings
320
+ - The number of `#` characters in the heading determines the level of the heading
321
+ - The level is used to index into the icon table using a cycle
322
+ - The icon is left padded with spaces to fill the gap and hide any additional `#`
323
+ - The level is also used to index into both highlights tables using a clamp
324
+ - Both are applied to the icon and the background extends through the entire line
325
325
326
326
327
327
DASHED LINE *render-markdown-setup-dashed-line*
328
328
329
- Icon: `dash` Highlight: `highlights.dash` Style: N/A
330
-
331
- Gets repeated across the window’s width when a `thematic_break` is found.
329
+ - Icon: `dash`
330
+ - Highlight: `highlights.dash`
331
+ - Style: N/A
332
+ - Gets repeated across the window’s width when a `thematic_break` is found
332
333
333
334
334
335
LIST BULLETS *render-markdown-setup-list-bullets*
335
336
336
- Icon: `bullets` Highlight: `highlights.bullet` Style: N/A
337
-
338
- The icons replace the `- ` , `+ ` , and `* ` characters in front of list items. How
339
- deeply nested the list is determines the level of the list. The level is used
340
- to index into the icon table using a cycle. If the item is a `checkbox` a
341
- conceal is instead used to hide the bullet.
337
+ - Icon: `bullets`
338
+ - Highlight: `highlights.bullet`
339
+ - Style: N/A
340
+ - The icons replace the `- ` , `+ ` , and `* ` characters in front of list items
341
+ - How deeply nested the list is determines the level of the list
342
+ - The level is used to index into the icon table using a cycle
343
+ - If the item is a `checkbox` a conceal is instead used to hide the bullet
342
344
343
345
344
346
CHECKBOXES *render-markdown-setup-checkboxes*
345
347
346
- Icon: `checkbox.unchecked` , `checkbox.checkbox` , & `checkbox.custom .rendered`
347
- Highlight: `highlights.checkbox.unchecked` , `highlights.checkbox.checked` , &
348
- `checkbox.custom .highlight ` Style: N/A
349
-
350
- In the case of a standard checked `[x ]` or unchecked `[ ]` checkbox state we
351
- simply overlay the appropriate icon and apply the appropriate highlight.
352
-
353
- Custom checkbox states setup through `checkbox.custom ` are more involved as
354
- they are not part of the actual `markdown` grammar. As a result this requires
355
- neovim >= `0.10 .0 ` since it relies on `inline` extmarks. An example comes with
356
- the default config: `todo = { raw = '[-]', rendered = ' ', highlight =
357
- '@markup.raw' }` The key part in this case `todo ` is unused. The parts of the
358
- value are: - `raw` : matched against the raw text of a `shortcut_link` -
359
- `rendered` : replaces the `raw` value when rendering - `highlight ` : color used
360
- for `rendered` text
348
+ - Icon: `checkbox.unchecked` , `checkbox.checkbox` , & `checkbox.custom .rendered`
349
+ - Highlight: `highlights.checkbox.unchecked` , `highlights.checkbox.checked` , &
350
+ `checkbox.custom .highlight `
351
+ - Style: N/A
352
+ - In the case of a standard checked `[x ]` or unchecked `[ ]` checkbox state we
353
+ simply overlay the appropriate icon and apply the appropriate highlight
354
+ - Custom checkbox states setup through `checkbox.custom ` are more involved as
355
+ they are not part of the actual `markdown` grammar
356
+ - As a result this requires neovim >= `0.10 .0 ` since it relies on `inline`
357
+ extmarks
358
+ - An example comes with the default config: `todo = { raw = '[-]', rendered =
359
+ ' ', highlight = '@markup.raw' }`
360
+ - The key part in this case `todo ` is unused. The parts of the value are:
361
+ - `raw` : matched against the raw text of a `shortcut_link`
362
+ - `rendered` : replaces the `raw` value when rendering
363
+ - `highlight ` : color used for `rendered` text
361
364
362
365
363
366
STANDARD QUOTES *render-markdown-setup-standard-quotes*
364
367
365
- Icon: `quote` Highlight: `highlights.quote` Style: N/A
366
-
367
- The icon replaces the `|` character in front of `block_quotes` .
368
+ - Icon: `quote`
369
+ - Highlight: `highlights.quote`
370
+ - Style: N/A
371
+ - The icon replaces the `|` character in front of `block_quotes`
368
372
369
373
370
374
CALLOUTS *render-markdown-setup-callouts*
371
375
372
- Icon: `callout` & `callout.custom .rendered` Highlight: `highlights.callout` &
373
- `callout.custom .highlight ` Style: N/A
374
-
375
- Callouts are a special instance of a `block_quote` that start with a
376
- `shortcut_link` . When this pattern is seen the link text gets replaced by the
377
- icon. The highlight is then applied to the icon as well as the quote markers.
378
-
379
- Custom callouts setup through `callout.custom ` behave in much the same way. An
380
- example comes with the default config: `bug = { raw = '[!BUG]', rendered =
381
- ' Bug', highlight = 'DiagnosticError' }` The key part in this case `bug` is
382
- unused. The parts of the value are: - `raw` : matched against the raw text of a
383
- `shortcut_link` - `rendered` : replaces the `raw` value when rendering -
384
- `highlight ` : color used for `rendered` text
376
+ - Icon: `callout` & `callout.custom .rendered`
377
+ - Highlight: `highlights.callout` & `callout.custom .highlight `
378
+ - Style: N/A
379
+ - Callouts are a special instance of a `block_quote` that start with a
380
+ `shortcut_link`
381
+ - When this pattern is seen the link text gets replaced by the icon
382
+ - The highlight is then applied to the icon as well as the quote markers
383
+ - Custom callouts setup through `callout.custom ` behave in much the same way
384
+ - An example comes with the default config: `bug = { raw = '[!BUG]', rendered =
385
+ ' Bug', highlight = 'DiagnosticError' }`
386
+ - The key part in this case `bug` is unused. The parts of the value are:
387
+ - `raw` : matched against the raw text of a `shortcut_link`
388
+ - `rendered` : replaces the `raw` value when rendering
389
+ - `highlight ` : color used for `rendered` text
385
390
386
391
387
392
CODE BLOCKS *render-markdown-setup-code-blocks*
388
393
389
- Icon: N/A Highlight: `highlights.code` Style: `code_style`
390
-
391
- `code_style` determines how code blocks are rendered: - `none ` : disables all
392
- rendering - `normal ` : adds highlight group to the code block - `full` : `normal `
393
- + language icon & name above the code block
394
+ - Icon: N/A
395
+ - Highlight: `highlights.code`
396
+ - Style: `code_style`
397
+ - `code_style` determines how code blocks are rendered:
398
+ - `none ` : disables all rendering
399
+ - `normal ` : adds highlight group to the code block
400
+ - `full` : `normal ` + language icon & name above the code block
394
401
395
402
396
403
TABLES *render-markdown-setup-tables*
397
404
398
- Icon: N/A Highlight: `highlights.table.head` & `highlights.table.row` Style:
399
- `table_style` & `cell_style`
400
-
401
- The `head` highlight is used for the table heading, delimitter, and the line
402
- above. The `row` highlight is used for everything else, main table rows and the
403
- line below.
404
-
405
- `table_style` determines how the table as a whole is rendered: - `none ` :
406
- disables all rendering - `normal ` : applies the `cell_style` rendering to each
407
- row of the table - `full` : `normal ` + a top & bottom line that fill out the
408
- table when lengths match
409
-
410
- `cell_style` determines how individual cells of a table are rendered: -
411
- `overlay` : writes completely over the table, removing conceal behavior and
412
- highlights - `raw` : replaces only the `|` icons in each row, leaving the cell
413
- completely unmodified
405
+ - Icon: N/A
406
+ - Highlight: `highlights.table.head` & `highlights.table.row`
407
+ - Style: `table_style` & `cell_style`
408
+ - The `head` highlight is used for the table heading, delimitter, and the line
409
+ above
410
+ - The `row` highlight is used for everything else, main table rows and the line
411
+ below
412
+ - `table_style` determines how the table as a whole is rendered:
413
+ - `none ` : disables all rendering
414
+ - `normal ` : applies the `cell_style` rendering to each row of the table
415
+ - `full` : `normal ` + a top & bottom line that fill out the table when lengths match
416
+ - `cell_style` determines how individual cells of a table are rendered:
417
+ - `overlay` : writes completely over the table, removing conceal behavior and highlights
418
+ - `raw` : replaces only the `|` icons in each row, leaving the cell completely unmodified
414
419
415
420
416
421
==============================================================================
0 commit comments