Add tests and documentation for strikethrough element

2026-08-28 04:46:29 -04:00 · 2019-12-28 06:07:17 +01:00
parent 84795ad72f
commit d3bde07b2f
5 changed files with 33 additions and 0 deletions
@@ -510,6 +510,32 @@ Output:

 ---

+### strikethrough
+
+The `strikethrough` element represents strikethrough text.
+
+#### Example
+
+Markdown:
+
+```markdown
+~~Scratch this~~.
+```
+
+Style:
+
+```json
+"strikethrough": {
+    "crossed_out": true
+}
+```
+
+Output:
+
+![Strikethrough Example](https://github.com/charmbracelet/glamour/raw/master/styles/examples/strikethrough.png)
+
+---
+
 ### hr

 The `hr` element represents a horizontal rule.
@@ -0,0 +1 @@
+~~Scratch this~~.
@@ -0,0 +1,5 @@
+{
+    "strikethrough": {
+        "crossed_out": true
+    }
+}
@@ -0,0 +1 @@
+[9m[0m[9m[0m[9mScratch this[0m.                                                                   [0m[0m