doc: add description for turndown options

telesoho · Jun 27, 2024 · e156088 · e156088
1 parent d347075
commit e156088
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -12,6 +12,14 @@
   "MarkdownPaste.nameBase": "image",
   "MarkdownPaste.nameSuffix": "_${datetime}",
   "MarkdownPaste.path": "${fileWorkspaceFolder}/res/images",
-  "MarkdownPaste.namePrefix": "${fileBasename}_"
+  "MarkdownPaste.namePrefix": "${fileBasename}_",
+  "MarkdownPaste.turndownOptions": {
+    "headingStyle": "atx",
+    "bulletListMarker": "-",
+    "strongDelimiter": "**",
+    "emDelimiter": "*",
+    "preformattedCode": "true",
+    "hr": "\n\n* * * *\n\n"
+  }
 }  
 
diff --git a/README.md b/README.md
@@ -179,6 +179,12 @@ Smartly paste for Markdown.
 
   Default value is `True`.
 
+- `MarkdownPaste.turndownOptions`
+
+  Use turndown options when cover html to markdown, please see  [turndown options](https://github.com/mixmark-io/turndown#options) for detail.
+
+  Default value is `setext`
+
 - `MarkdownPaste.lang_rules`
 
   As `MarkdownPaste.rules`, you can define rules for other language (for example: asciidoc).