markdown-it-configurator (#626)

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Co-authored-by: Erik Michelson <github@erik.michelson.eu>

src/components/markdown-renderer/markdown-it-configurator/BasicMarkdownItConfigurator.tsx

@@ -0,0 +1,33 @@
+import MarkdownIt from 'markdown-it'
+import abbreviation from 'markdown-it-abbr'
+import definitionList from 'markdown-it-deflist'
+import footnote from 'markdown-it-footnote'
+import imsize from 'markdown-it-imsize'
+import inserted from 'markdown-it-ins'
+import marked from 'markdown-it-mark'
+import subscript from 'markdown-it-sub'
+import superscript from 'markdown-it-sup'
+import { linkifyExtra } from '../markdown-it-plugins/linkify-extra'
+import { MarkdownItParserDebugger } from '../markdown-it-plugins/parser-debugger'
+import { twitterEmojis } from '../markdown-it-plugins/twitter-emojis'
+import { MarkdownItConfigurator } from './MarkdownItConfigurator'
+
+export class BasicMarkdownItConfigurator extends MarkdownItConfigurator {
+  protected configure (markdownIt: MarkdownIt): void {
+    this.configurations.push(
+      twitterEmojis,
+      abbreviation,
+      definitionList,
+      subscript,
+      superscript,
+      inserted,
+      marked,
+      footnote,
+      imsize
+    )
+    this.postConfigurations.push(
+      linkifyExtra,
+      MarkdownItParserDebugger
+    )
+  }
+}

src/components/markdown-renderer/markdown-it-configurator/FullMarkdownItConfigurator.tsx

@@ -0,0 +1,63 @@
+import MarkdownIt from 'markdown-it'
+import { TocAst } from '../../../external-types/markdown-it-toc-done-right/interface'
+import { RawYAMLMetadata } from '../../editor/yaml-metadata/yaml-metadata'
+import { alertContainer } from '../markdown-it-plugins/alert-container'
+import { documentToc } from '../markdown-it-plugins/document-toc'
+import { frontmatterExtract } from '../markdown-it-plugins/frontmatter'
+import { headlineAnchors } from '../markdown-it-plugins/headline-anchors'
+import { highlightedCode } from '../markdown-it-plugins/highlighted-code'
+import { plantumlWithError } from '../markdown-it-plugins/plantuml'
+import { quoteExtra } from '../markdown-it-plugins/quote-extra'
+import { tasksLists } from '../markdown-it-plugins/tasks-lists'
+import { legacySlideshareShortCode } from '../regex-plugins/replace-legacy-slideshare-short-code'
+import { legacySpeakerdeckShortCode } from '../regex-plugins/replace-legacy-speakerdeck-short-code'
+import { AsciinemaReplacer } from '../replace-components/asciinema/asciinema-replacer'
+import { GistReplacer } from '../replace-components/gist/gist-replacer'
+import { KatexReplacer } from '../replace-components/katex/katex-replacer'
+import { LineMarkers, lineNumberMarker } from '../replace-components/linemarker/line-number-marker'
+import { PdfReplacer } from '../replace-components/pdf/pdf-replacer'
+import { VimeoReplacer } from '../replace-components/vimeo/vimeo-replacer'
+import { YoutubeReplacer } from '../replace-components/youtube/youtube-replacer'
+import { BasicMarkdownItConfigurator } from './BasicMarkdownItConfigurator'
+
+export class FullMarkdownItConfigurator extends BasicMarkdownItConfigurator {
+  constructor (
+    private useFrontmatter: boolean,
+    private onYamlError: (error: boolean) => void,
+    private onRawMeta: (rawMeta: RawYAMLMetadata) => void,
+    private onToc: (toc: TocAst) => void,
+    private onLineMarkers: (lineMarkers: LineMarkers[]) => void
+  ) {
+    super()
+  }
+
+  protected configure (markdownIt: MarkdownIt): void {
+    super.configure(markdownIt)
+
+    this.configurations.push(
+      plantumlWithError,
+      tasksLists,
+      (markdownIt) => {
+        frontmatterExtract(markdownIt,
+          !this.useFrontmatter ? undefined : {
+            onYamlError: (error: boolean) => this.onYamlError(error),
+            onRawMeta: (rawMeta: RawYAMLMetadata) => this.onRawMeta(rawMeta)
+          })
+      },
+      headlineAnchors,
+      KatexReplacer.markdownItPlugin,
+      YoutubeReplacer.markdownItPlugin,
+      VimeoReplacer.markdownItPlugin,
+      GistReplacer.markdownItPlugin,
+      legacySlideshareShortCode,
+      legacySpeakerdeckShortCode,
+      PdfReplacer.markdownItPlugin,
+      AsciinemaReplacer.markdownItPlugin,
+      highlightedCode,
+      quoteExtra,
+      (markdownIt) => documentToc(markdownIt, this.onToc),
+      alertContainer,
+      (markdownIt) => lineNumberMarker(markdownIt, (lineMarkers) => this.onLineMarkers(lineMarkers))
+    )
+  }
+}

src/components/markdown-renderer/markdown-it-configurator/MarkdownItConfigurator.tsx

@@ -0,0 +1,26 @@
+import MarkdownIt from 'markdown-it'
+
+export abstract class MarkdownItConfigurator {
+  protected configurations:MarkdownIt.PluginSimple[] = [];
+  protected postConfigurations:MarkdownIt.PluginSimple[] = [];
+
+  protected abstract configure(markdownIt: MarkdownIt): void;
+
+  public pushConfig (plugin: MarkdownIt.PluginSimple): this {
+    this.configurations.push(plugin)
+    return this
+  }
+
+  public buildConfiguredMarkdownIt (): MarkdownIt {
+    const markdownIt = new MarkdownIt('default', {
+      html: true,
+      breaks: true,
+      langPrefix: '',
+      typographer: true
+    })
+    this.configure(markdownIt)
+    this.configurations.forEach((configuration) => markdownIt.use(configuration))
+    this.postConfigurations.forEach((postConfiguration) => markdownIt.use(postConfiguration))
+    return markdownIt
+  }
+}