summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJesse Hathaway <jesse@mbuki-mvuki.org>2021-07-04 07:39:29 -0500
committerGitHub <noreply@github.com>2021-07-04 21:39:29 +0900
commit36fcb01e05979b410da1dcee10979b0f4e610eb6 (patch)
treedad3fad01d795f7017b357ff74ba7b4497eed678 /doc
parente4ddd32c840c405b12abe76fefc860062989e429 (diff)
downloadale-36fcb01e05979b410da1dcee10979b0f4e610eb6.zip
Add pandoc as a markdown fixer (#3641)
Utilize pandoc to fix markdown files, currently set to Github-Flavored Markdown, but that can be changed by setting, ale_markdown_pandoc_options.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-markdown.txt19
-rw-r--r--doc/ale-supported-languages-and-tools.txt1
-rw-r--r--doc/ale.txt1
3 files changed, 21 insertions, 0 deletions
diff --git a/doc/ale-markdown.txt b/doc/ale-markdown.txt
index 99848878..feb37fc9 100644
--- a/doc/ale-markdown.txt
+++ b/doc/ale-markdown.txt
@@ -34,6 +34,25 @@ g:ale_markdown_mdl_options *g:ale_markdown_mdl_options*
===============================================================================
+pandoc *ale-markdown-pandoc*
+
+g:ale_markdown_pandoc_executable *g:ale_markdown_pandoc_executable*
+ *b:ale_markdown_pandoc_executable*
+ Type: |String|
+ Default: `'pandoc'`
+
+ This variable can be set to specify where to find the pandoc executable
+
+
+g:ale_markdown_pandoc_options *g:ale_markdown_pandoc_options*
+ *b:ale_markdown_pandoc_options*
+ Type: |String|
+ Default: `'-f gfm -t gfm -s -'`
+
+ This variable can be set to change the default options passed to pandoc
+
+
+===============================================================================
prettier *ale-markdown-prettier*
See |ale-javascript-prettier| for information about the available options.
diff --git a/doc/ale-supported-languages-and-tools.txt b/doc/ale-supported-languages-and-tools.txt
index 71fb64b8..36399178 100644
--- a/doc/ale-supported-languages-and-tools.txt
+++ b/doc/ale-supported-languages-and-tools.txt
@@ -301,6 +301,7 @@ Notes:
* `languagetool`!!
* `markdownlint`!!
* `mdl`
+ * `pandoc`
* `prettier`
* `proselint`
* `redpen`
diff --git a/doc/ale.txt b/doc/ale.txt
index 6c6a363e..5d2ff444 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -2847,6 +2847,7 @@ documented in additional help files.
markdown................................|ale-markdown-options|
markdownlint..........................|ale-markdown-markdownlint|
mdl...................................|ale-markdown-mdl|
+ pandoc................................|ale-markdown-pandoc|
prettier..............................|ale-markdown-prettier|
remark-lint...........................|ale-markdown-remark-lint|
textlint..............................|ale-markdown-textlint|