From cef174337d72c38fab90ea00009126da423a88f9 Mon Sep 17 00:00:00 2001
From: SukkaW <isukkaw@gmail.com>
Date: Mon, 30 Nov 2020 11:07:02 +0800
Subject: [PATCH] docs: descriptionLists option

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index fdec0de..e2a04b3 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,7 @@ marked:
     exclude: []
     nofollow: false
   disableNunjucks: false
+  descriptionLists: true
 ```
 
 - **gfm** - Enables [GitHub flavored markdown](https://help.github.com/articles/github-flavored-markdown)
@@ -82,6 +83,9 @@ marked:
   * **nofollow** - Add `rel="noopener external nofollow noreferrer"` to all external links for security, privacy and SEO. [Read more](https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types). _This can be enabled regardless of `external_link.enable`_
     - Example: `[foo](http://bar.com)` becomes `<a href="http://bar.com" rel="noopener external nofollow noreferrer">foo</a>`
 - **disableNunjucks**: If true, Nunjucks tags `{{ }}` or `{% %}` (usually used by [tag plugins](https://hexo.io/docs/tag-plugins)) will not be rendered.
+- **descriptionLists**: Enable support for [description lists syntax](https://kramdown.gettalong.org/syntax.html#definition-lists).
+  * Currently description lists syntax is not in neither [CommonMark](http://commonmark.org/) or [GFM](https://github.github.com/gfm/#task-list-items-extension-), `hexo-renderer-marked` only provides the option for backward compatibility.
+  * By disabling the `descriptionLists`, markdown rendering performance will be improved by **a lot**.
 
 For more options, see [Marked](https://marked.js.org/using_advanced#options). Due to the customizations implemented by this plugin, some of the Marked's options may not work as expected. Feel free to raise an [issue](https://github.com/hexojs/hexo-renderer-marked/issues) to us for clarification.