Skip to content

Commit f6c9e18

Browse files
chore: add config validation to troubleshooting doc
1 parent e05a9f2 commit f6c9e18

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ body:
4949
- type: textarea
5050
attributes:
5151
label: Plugin configuration
52-
description: Your configuration for this plugin.
52+
description: Your configuration for this plugin (:RenderMarkdown config).
5353
render: lua
5454
validations:
5555
required: true

doc/render-markdown.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*render-markdown.txt* For 0.10.0 Last change: 2025 February 12
1+
*render-markdown.txt* For 0.10.0 Last change: 2025 February 17
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*

doc/troubleshooting.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ the `filetype` of the current buffer and make sure it is in that list:
3131
:lua vim.print(vim.bo.filetype)
3232
```
3333

34+
## Validate Configuration
35+
36+
This is only a potential issue if you are using a distribution, as opposed to your
37+
own configuration. The configuration for this plugin could be set by the distribution
38+
to some default the author prefers. So the settings you think you are using are not
39+
necessarily the only ones be used.
40+
41+
Run `:RenderMarkdown config`, which will output only the non-default values being
42+
used, you might be surprised what you find.
43+
3444
## Validate Parse Tree
3545

3646
Create a new `markdown` file locally with the following content:
@@ -111,6 +121,6 @@ This should trigger the rendering logic, then close Neovim.
111121

112122
### 4) Provide Logs in Issue
113123

114-
Logs are written to a file typically located at: `~/.local/state/nvim/render-markdown.log`.
124+
Logs can be retrieved by running `:RenderMarkdown log`.
115125

116-
Copy the contents of that file and paste it into the issue.
126+
Copy the contents and paste them into the issue.

0 commit comments

Comments
 (0)