Merge pull request #62 from jannis-baum/issue/61-add-definition-lists

Add definition lists
jannis-baum · Apr 29, 2024 · 25c7803 · 25c7803
2 parents 99b128d + b324651
commit 25c7803
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -25,6 +25,7 @@
     "katex": "^0.15.6",
     "markdown-it": "^13.0.1",
     "markdown-it-anchor": "^8.6.7",
+    "markdown-it-deflist": "^3.0.0",
     "markdown-it-emoji": "^2.0.2",
     "markdown-it-footnote": "^4.0.0",
     "markdown-it-inject-linenumbers": "^0.3.0",

diff --git a/src/parser/parser.ts b/src/parser/parser.ts
@@ -27,6 +27,7 @@ mdit.use(require('markdown-it-texmath'), {
     delimiters: 'dollars',
     katexOptions: config.katexOptions,
 });
+mdit.use(require('markdown-it-deflist'));
 /* eslint-enable @typescript-eslint/no-var-requires */
 mdit.use(graphviz);
 

diff --git a/static/style.css b/static/style.css
@@ -135,6 +135,32 @@ section.footnotes {
     color: #7d7d7d;
 }
 
+/* --------------------------------------------------------------------------
+ * DEFIITION LISTS ---------------------------------------------------------- */
+
+dl {
+    display: flex;
+    flex-flow: row wrap;
+}
+dt {
+    flex-basis: 20%;
+    text-align: right;
+    font-weight: bold;
+    box-sizing: border-box;
+    padding: 0.25em;
+    border-right: 0.2px solid #444;
+    margin: 0.25em 0;
+}
+dd {
+    flex-basis: 80%;
+    flex-grow: 1;
+    text-align: left;
+    box-sizing: border-box;
+    margin: 0;
+    padding: 0.25em;
+    margin: 0.25em 0;
+}
+
 /* --------------------------------------------------------------------------
  * LIGHT MODE --------------------------------------------------------------- */
 @media (prefers-color-scheme: light) {

diff --git a/yarn.lock b/yarn.lock
@@ -1557,6 +1557,11 @@ markdown-it-anchor@^8.6.7:
   resolved "https://registry.yarnpkg.com/markdown-it-anchor/-/markdown-it-anchor-8.6.7.tgz#ee6926daf3ad1ed5e4e3968b1740eef1c6399634"
   integrity sha512-FlCHFwNnutLgVTflOYHPW2pPcl2AACqVzExlkGQNsi4CJgqOHN7YTgDd4LuhgN1BFO3TS0vLAruV1Td6dwWPJA==
 
+markdown-it-deflist@^3.0.0:
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/markdown-it-deflist/-/markdown-it-deflist-3.0.0.tgz#f2beb0b308beae5a62f62cca7fde0de48dcbe3de"
+  integrity sha512-OxPmQ/keJZwbubjiQWOvKLHwpV2wZ5I3Smc81OjhwbfJsjdRrvD5aLTQxmZzzePeO0kbGzAo3Krk4QLgA8PWLg==
+
 markdown-it-emoji@^2.0.2:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/markdown-it-emoji/-/markdown-it-emoji-2.0.2.tgz#cd42421c2fda1537d9cc12b9923f5c8aeb9029c8"