mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-12-27 09:09:07 +01:00
52b48140fe
This allows <Class>.md beside <Class>.ts where we can add additional documentation such as examples
68 lines
1.8 KiB
JavaScript
68 lines
1.8 KiB
JavaScript
const MarkdownIt = require('markdown-it');
|
|
const markdownItContainer = require('markdown-it-container');
|
|
const markdownItIns = require('markdown-it-ins');
|
|
const markdownItKbd = require('markdown-it-kbd');
|
|
const markdownItMark = require('markdown-it-mark');
|
|
const markdownItReplaceIt = require('markdown-it-replace-it');
|
|
|
|
const markdown = MarkdownIt({
|
|
html: true,
|
|
xhtmlOut: false,
|
|
breaks: false,
|
|
langPrefix: 'language-',
|
|
linkify: false,
|
|
typographer: false
|
|
});
|
|
|
|
// Third-party plugins
|
|
markdown.use(markdownItContainer);
|
|
markdown.use(markdownItIns);
|
|
markdown.use(markdownItKbd);
|
|
markdown.use(markdownItMark);
|
|
markdown.use(markdownItReplaceIt);
|
|
|
|
// Callouts
|
|
['tip', 'warning', 'danger'].forEach(type => {
|
|
markdown.use(markdownItContainer, type, {
|
|
render: function (tokens, idx) {
|
|
if (tokens[idx].nesting === 1) {
|
|
return `<div role="alert" class="callout callout--${type}">`;
|
|
}
|
|
return '</div>\n';
|
|
}
|
|
});
|
|
});
|
|
|
|
// Asides
|
|
markdown.use(markdownItContainer, 'aside', {
|
|
render: function (tokens, idx) {
|
|
if (tokens[idx].nesting === 1) {
|
|
return `<aside>`;
|
|
}
|
|
return '</aside>\n';
|
|
}
|
|
});
|
|
|
|
// Details
|
|
markdown.use(markdownItContainer, 'details', {
|
|
validate: params => params.trim().match(/^details\s+(.*)$/),
|
|
render: (tokens, idx) => {
|
|
const m = tokens[idx].info.trim().match(/^details\s+(.*)$/);
|
|
if (tokens[idx].nesting === 1) {
|
|
return `<details>\n<summary><span>${markdown.utils.escapeHtml(m[1])}</span></summary>\n`;
|
|
}
|
|
return '</details>\n';
|
|
}
|
|
});
|
|
|
|
// Replace [#1234] with a link to GitHub issues
|
|
markdownItReplaceIt.replacements.push({
|
|
name: 'github-issues',
|
|
re: /\[#([0-9]+)\]/gs,
|
|
sub: '<a href="https://github.com/egroupware/egroupware/issues/$1">#$1</a>',
|
|
html: true,
|
|
default: true
|
|
});
|
|
|
|
module.exports = markdown;
|