github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-02-03 02:52:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

added support for markdown-it-deflist (#240)

Browse source 
this makes it possible to use definition lists like
```
Term 1

:   Definition 1
with lazy continuation.

Term 2 with *inline markup*

:   Definition 2

        { some code, part of Definition 2 }

    Third paragraph of definition 2.

_Compact style:_

Term 1
  ~ Definition 1

Term 2
  ~ Definition 2a
  ~ Definition 2b
```

Co-authored-by: Philip Molares <philip@mauricedoepke.de>
This commit is contained in:
Philip Molares 2020-06-20 19:25:31 +02:00 committed by GitHub
parent 1703818b91
commit 09c21e4334
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
package.json
View file

@ -38,6 +38,7 @@
"i18next-browser-languagedetector": "5.0.0",
"i18next-http-backend": "1.0.15",
"markdown-it": "11.0.0",
"markdown-it-deflist": "^2.0.3",
"markdown-it-emoji": "1.4.0",
"markdown-it-ins": "^3.0.0",
"markdown-it-mark": "^3.0.0",

2
src/components/editor/markdown-preview/markdown-preview.tsx
View file

@ -2,6 +2,7 @@ import MarkdownIt from 'markdown-it'
import emoji from 'markdown-it-emoji'
import markdownItRegex from 'markdown-it-regex'
import taskList from 'markdown-it-task-lists'
import definitionList from 'markdown-it-deflist'
import subscript from 'markdown-it-sub'
import superscript from 'markdown-it-sup'
import inserted from 'markdown-it-ins'
@ -39,6 +40,7 @@ const MarkdownPreview: React.FC<MarkdownPreviewProps> = ({ content }) => {
})
md.use(taskList)
md.use(emoji)
md.use(definitionList)
md.use(subscript)
md.use(superscript)
md.use(inserted)

6
src/external-types/markdown-it-deflist/index.d.ts vendored Normal file
View file

@ -0,0 +1,6 @@
declare module 'markdown-it-deflist' {
import MarkdownIt from 'markdown-it/lib'
const markdownItDefinitionList: MarkdownIt.PluginSimple
export = markdownItDefinitionList
}

5
yarn.lock
View file

@ -7270,6 +7270,11 @@ map-visit@^1.0.0:
dependencies:
object-visit "^1.0.0"
markdown-it-deflist@^2.0.3:
version "2.0.3"
resolved "https://registry.yarnpkg.com/markdown-it-deflist/-/markdown-it-deflist-2.0.3.tgz#5727db04184d3cb2bc6ee4a9641e3a1091d5fd6f"
integrity sha512-/BNZ8ksW42bflm1qQLnRI09oqU2847Z7MVavrR0MORyKLtiUYOMpwtlAfMSZAQU9UCvaUZMpgVAqoS3vpToJxw==
markdown-it-emoji@1.4.0:
version "1.4.0"
resolved "https://registry.yarnpkg.com/markdown-it-emoji/-/markdown-it-emoji-1.4.0.tgz#9bee0e9a990a963ba96df6980c4fddb05dfb4dcc"