From 85a737b4ee72fb4dba12e1aacbd87d1636cfc30e Mon Sep 17 00:00:00 2001
From: Xinyang Yu <47915643+xy-241@users.noreply.github.com>
Date: Sun, 24 Mar 2024 16:33:53 +0000
Subject: [PATCH] docs: Update showcase.md (#1031)

---
 docs/plugins/Description.md |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/docs/plugins/Description.md b/docs/plugins/Description.md
index 6849b3c..526bb01 100644
--- a/docs/plugins/Description.md
+++ b/docs/plugins/Description.md
@@ -14,6 +14,7 @@
 This plugin accepts the following configuration options:
 
 - `descriptionLength`: the maximum length of the generated description. Default is 150 characters. The cut off happens after the first _sentence_ that ends after the given length.
+- `replaceExternalLinks`: If `true` (default), replace external links with their domain and path in the description (e.g. `https://domain.tld/some_page/another_page?query=hello&target=world` is replaced with `domain.tld/some_page/another_page`).
 
 ## API
 

--
Gitblit v1.10.0