fix: fix #47 docs error

shellRaining · Jun 11, 2023 · 60f07ee · 60f07ee
1 parent 02c03f3
commit 60f07ee
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -99,6 +99,14 @@ The script comes with the following defaults:
         enable = true,
         use_treesitter = true,
         notify = true, -- notify if some situation(like disable chunk mod double time)
+        exclude_filetypes = {
+            aerial = true,
+            dashboard = true,
+        }
+        support_filetypes = {
+            "*.lua",
+            "*.js",
+        }
         chars = {
             horizontal_line = "─",
             vertical_line = "│",

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -99,6 +99,14 @@ Plug "shellRaining/hlchunk.nvim"
     chunk = {
         enable = true,
         notify = true, -- 在某些情况下弹出提示（比如连续两次使用 disableHLChunk 命令）
+        exclude_filetypes = {
+            aerial = true,
+            dashboard = true,
+        }
+        support_filetypes = {
+            "*.lua",
+            "*.js",
+        }
         use_treesitter = true,
         chars = {
             horizontal_line = "─",

diff --git a/docs/en/blank.md b/docs/en/blank.md
@@ -29,12 +29,12 @@ chars = {
 
 `style` is a RGB string or RGB string list, if it is a table, it will choice different color to render different blank (indent)
 
-`exclude_filetype` is opposite of support_filetypes, it is a lua table like this
+`exclude_filetype` is opposite of support_filetypes, it is a lua table like this, same as chunk mod
 
 ```lua
 exclude_filetype = {
-    "help",
-    "plugin",
+    aerial = true,
+    NvimTree = true,
 }
 ```
 

diff --git a/docs/en/chunk.md b/docs/en/chunk.md
@@ -26,12 +26,12 @@ If set to false, the usercmd and autocmd it carries will not be generated, and t
 
 If set to false, vim's match will be used to highlight the code block, otherwise treesitter will be used to determine the current code block
 
-`exclude_filetypes` is a lua table type, example as follows
+`exclude_filetypes` is a lua table type, example as follows, the default exclude_filetypes can be found in the [default config](../../lua/hlchunk/utils/filetype.lua)
 
 ```lua
 exclude_filetypes = {
-    "lua",
-    "python",
+    aerial = true,
+    dashboard = true,
 }
 ```
 

diff --git a/docs/en/indent.md b/docs/en/indent.md
@@ -30,12 +30,12 @@ chars = {
 
 `style` is a RGB string or RGB string list, if it is a table, it will choice different color to render different indent line
 
-`exclude_filetype` is opposite of support_filetypes, it is a lua table like this
+`exclude_filetype` is opposite of support_filetypes, it is a lua table like this, the default exclude_filetypes can be found in the [default config](../../lua/hlchunk/utils/filetype.lua)
 
 ```lua
 exclude_filetype = {
-    "help",
-    "plugin",
+    aerial = true,
+    NvimTree = true,
 }
 ```
 

diff --git a/docs/zh_CN/blank.md b/docs/zh_CN/blank.md
@@ -29,12 +29,12 @@ chars = {
 
 `style` 是一个 RGB 字符串或者一个表，如果是表，他将会使用不同颜色来渲染 blank
 
-`exclude_filetype` 是 support_filetype 的反面，用来控制在哪些文件类型不渲染 blank
+`exclude_filetype` 是 support_filetype 的反面，用来控制在哪些文件类型不渲染 blank，默认的 exclude_filetypes 可以在 [default config](../../lua/hlchunk/utils/filetype.lua) 中找到
 
 ```lua
 exclude_filetype = {
-    "help",
-    "plugin",
+    aerial = true,
+    NvimTree = true,
 }
 ```
 

diff --git a/docs/zh_CN/chunk.md b/docs/zh_CN/chunk.md
@@ -28,12 +28,12 @@ chunk mod 有四个配置项
 
 如果设置为 false，将使用 vim 的 match 来高亮代码块，反之使用 treesitter 来判断当前代码块
 
-`exclude_filetypes` 是一个 lua table 类型，例子如下
+`exclude_filetypes` 是一个 lua table 类型，例子如下，默认的 exclude_filetypes 可以在 [default config](../../lua/hlchunk/utils/filetype.lua) 中找到
 
 ```lua
 exclude_filetypes = {
-    "lua",
-    "python",
+    aerial = true,
+    dashboard = true,
 }
 ```
 

diff --git a/docs/zh_CN/indent.md b/docs/zh_CN/indent.md
@@ -30,12 +30,12 @@ chars = {
 
 `style` 是一个 RGB 字符串或者一个表，如果是表，他将会使用不同颜色来渲染 indent line
 
-`exclude_filetype` 是 support_filetype 的反面，用来控制在哪些文件类型不渲染 indent line
+`exclude_filetype` 是 support_filetype 的反面，用来控制在哪些文件类型不渲染 indent line，默认的 exclude_filetypes 可以在 [default config](../../lua/hlchunk/utils/filetype.lua) 中找到
 
 ```lua
 exclude_filetype = {
-    "help",
-    "plugin",
+    aerial = true,
+    NvimTree = true,
 }
 ```