Ghost/ghost/admin/app/utils/format-markdown.js
Scott Beinlich 80326996f5 🐛 Fixed markdown card lacking superscripts & subscripts. (#1763)
fixes: https://github.com/TryGhost/Ghost/issues/12219

- the WYSIWYG editor supports ^2^ for superscript and ~2~ for subscript
- with this change, the same syntax is supported in the markdown card, which was missing

Co-authored-by: Hannah Wolfe <github.erisds@gmail.com>
2022-08-01 19:51:27 +01:00

70 lines
2.0 KiB
JavaScript

import markdownit from 'markdown-it';
import markdownitFootnote from 'markdown-it-footnote';
import markdownitLazyHeaders from 'markdown-it-lazy-headers';
import markdownitMark from 'markdown-it-mark';
import markdownitSubscript from 'markdown-it-sub';
import markdownitSuperscript from 'markdown-it-sup';
import {sanitizeHtml} from 'koenig-editor/helpers/sanitize-html';
let slugify = function slugify(inputString, usedHeaders) {
let slug = inputString.replace(/[^\w]/g, '').toLowerCase();
if (usedHeaders[slug]) {
usedHeaders[slug] += 1;
slug += usedHeaders[slug];
}
return slug;
};
// originally from https://github.com/leff/markdown-it-named-headers
// moved here to avoid pulling in http://stringjs.com dependency
let markdownitNamedHeaders = function markdownitNamedHeaders(md) {
let originalHeadingOpen = md.renderer.rules.heading_open;
// eslint-disable-next-line camelcase
md.renderer.rules.heading_open = function (tokens, idx, options, env, self) {
let usedHeaders = {};
tokens[idx].attrs = tokens[idx].attrs || [];
let title = tokens[idx + 1].children.reduce(function (acc, t) {
return acc + t.content;
}, '');
let slug = slugify(title, usedHeaders);
tokens[idx].attrs.push(['id', slug]);
if (originalHeadingOpen) {
return originalHeadingOpen.apply(this, arguments);
} else {
return self.renderToken(...arguments);
}
};
};
let md = markdownit({
html: true,
breaks: true,
linkify: true
})
.use(markdownitFootnote)
.use(markdownitLazyHeaders)
.use(markdownitMark)
.use(markdownitNamedHeaders)
.use(markdownitSubscript)
.use(markdownitSuperscript);
// configure linkify-it
md.linkify.set({
fuzzyLink: false
});
export default function formatMarkdown(_markdown, replaceJS = true) {
let markdown = _markdown || '';
let escapedhtml = '';
// convert markdown to HTML
escapedhtml = md.render(markdown);
return sanitizeHtml(escapedhtml, {replaceJS});
}