From: Hiroshi Shirosaki <h.shirosaki@gmail.com>
Date: Wed, 9 Jan 2019 11:20:30 +0000 (+0900)
Subject: Add documentation for strikethrough extension
X-Git-Url: https://git.madduck.net/etc/vim.git/commitdiff_plain/68e753f6c3dcfd167ee00f2b5a5e7c7e3db5edd0

Add documentation for strikethrough extension
---

diff --git a/README.md b/README.md
index 982248e..25b7087 100644
--- a/README.md
+++ b/README.md
@@ -277,6 +277,14 @@ JSON syntax highlight requires [vim-json](https://github.com/elzr/vim-json).
 let g:vim_markdown_json_frontmatter = 1
 ```
 
+#### Strikethrough
+
+Strikethrough uses two tildes. `~~Scratch this.~~`
+
+```vim
+let g:vim_markdown_strikethrough = 1
+```
+
 ### Adjust new list item indent
 
 You can adjust a new list indent. For example, you insert a single line like below:
diff --git a/doc/vim-markdown.txt b/doc/vim-markdown.txt
index 29ed66d..1e81ea2 100644
--- a/doc/vim-markdown.txt
+++ b/doc/vim-markdown.txt
@@ -24,6 +24,7 @@ Contents ~
    2. YAML Front Matter                        |vim-markdown-yaml-front-matter|
    3. TOML Front Matter                        |vim-markdown-toml-front-matter|
    4. JSON Front Matter                        |vim-markdown-json-front-matter|
+   5. Strikethrough                                |vim-markdown-strikethrough|
   11. Adjust new list item indent    |vim-markdown-adjust-new-list-item-indent|
   12. Do not require .md extensions for Markdown links
                 |vim-markdown-do-not-require-.md-extensions-for-markdown-links|
@@ -318,6 +319,14 @@ JSON syntax highlight requires vim-json [9].
 >
   let g:vim_markdown_json_frontmatter = 1
 <
+-------------------------------------------------------------------------------
+                                                   *vim-markdown-strikethrough*
+Strikethrough ~
+
+Strikethrough uses two tildes. '~~Scratch this.~~'
+>
+  let g:vim_markdown_strikethrough = 1
+<
 -------------------------------------------------------------------------------
                                      *vim-markdown-adjust-new-list-item-indent*
 Adjust new list item indent ~