switch to single tilde syntax

This commit is contained in:
Hans Pagel 2020-09-10 12:31:26 +02:00
parent d043efe923
commit 2d4f8cd3a6
2 changed files with 2 additions and 2 deletions

View File

@ -32,7 +32,7 @@ context('/api/extensions/strike', () => {
it('should make a striked text from the markdown shortcut', () => {
cy.get('.ProseMirror')
.type('~~Strike~~', {force: true})
.type('~Strike~', {force: true})
.contains('s', 'Strike')
})
})

View File

@ -1,7 +1,7 @@
# Strike
This extension is used to render ~~striked text~~. If you pass `<s>`, `<del>`, `<strike>` tags, or text with inline `style` attributes setting `text-decoration: line-through` in the editors initial content, they all will be rendered accordingly.
Type `~~two tildes~~` and the it will be magically ~~striked through~~ while you type.
Type `~text between tildes~` and it will be magically ~~striked through~~ while you type.
::: warning Restrictions
The extension will generate the corresponding `<s>` HTML tags when reading contents of the `Editor` instance. All text striked through, regardless of the method will be normalized to `<s>` HTML tags.