45 Commits

Author SHA1 Message Date
1dcc58c4b2 0.2.4 2023-05-18 21:38:06 -07:00
78f99afef0 do not render anchors to nowhere 2023-05-18 21:38:05 -07:00
9b25d2f22c 0.2.3 2023-05-18 21:33:38 -07:00
a9e51d837d update inline render to use same options 2023-05-18 21:33:37 -07:00
0800247b65 0.2.2 2023-05-18 21:28:31 -07:00
704447f7c0 0.2.1 2023-05-18 21:27:16 -07:00
e40db445a5 disable newly deprecated stuff 2023-05-18 21:27:09 -07:00
4274045fca 0.2.0 2023-05-18 21:20:46 -07:00
95c15ee027 updated marked to v5; better baseurl handling 2023-05-18 21:20:39 -07:00
e184b6f8b4 0.1.21 2023-05-13 22:12:04 -07:00
e601f45836 update bin scripts to work as symlinks 2023-05-13 22:11:59 -07:00
8203bbe763 0.1.20 2023-05-13 20:13:50 -07:00
2bd98c788d export 2023-05-13 20:13:49 -07:00
96f468c4f8 0.1.19 2023-05-13 20:12:44 -07:00
c06c01823b add sync inline renderer 2023-05-13 20:12:39 -07:00
8afb5423e3 0.1.18 2023-05-12 15:07:47 -07:00
0f83a56299 cleanup 2023-05-12 15:07:43 -07:00
ae7b491107 0.1.17 2023-05-12 14:59:49 -07:00
8599460702 whitelist rdfa tags/attrs in html sanitizer 2023-05-12 14:59:45 -07:00
fb52d31090 0.1.16 2023-05-12 14:54:12 -07:00
859064f00b add rdfa for breadcrumbs 2023-05-12 14:54:05 -07:00
7803b495c2 0.1.15 2023-05-12 14:43:14 -07:00
f48c0c6b75 fixing bug 2023-05-12 14:42:57 -07:00
34cacb48bb 0.1.14 2023-05-12 14:35:54 -07:00
7d5d29dade add support for breadcrumb navs 2023-05-12 14:35:49 -07:00
6ad670ba07 0.1.13 2023-05-11 18:02:48 -07:00
3ddde81e1c updates to markdown processing to allow custom elements 2023-05-11 18:02:40 -07:00
44315b324a 0.1.12 2023-05-09 21:53:51 -07:00
20cc517802 fix regexes 2023-05-09 21:53:43 -07:00
ac3c25150e 0.1.11 2023-05-09 21:48:08 -07:00
ac4d6786d3 fix regexes 2023-05-09 21:47:56 -07:00
b3c9ac0c5c 0.1.10 2023-05-09 21:38:38 -07:00
9d233a8dc3 fix regexes 2023-05-09 21:38:23 -07:00
126803c489 0.1.9 2023-05-09 21:32:55 -07:00
d9c3371245 first pass at color name => theme color processing for pikchr 2023-05-09 21:32:48 -07:00
3553ced719 0.1.8 2023-05-07 17:20:08 -07:00
715451f02f fix frontmatter parse flag 2023-05-07 17:19:55 -07:00
b2de8df538 0.1.7 2023-05-06 15:21:35 -07:00
25ae8b0bcb remove console.log 2023-05-06 15:21:31 -07:00
b5a427d669 0.1.6 2023-05-06 14:09:10 -07:00
455915dd98 readme 2023-05-06 14:08:59 -07:00
90f8c11288 0.1.5 2023-05-06 14:07:18 -07:00
4ceff93214 updates to frontmatter handling 2023-05-06 14:07:15 -07:00
a2866cade6 0.1.4 2023-05-06 14:05:00 -07:00
48041b5845 fix main declaration 2023-05-06 14:04:56 -07:00
15 changed files with 353 additions and 122 deletions

View File

@@ -1,2 +1,2 @@
#!/bin/sh
node $(dirname $0)/markdown2html.js $*
node $(dirname "$(readlink -f "$0")")/markdown2html.js $*

View File

@@ -1,2 +1,2 @@
#!/bin/sh
node $(dirname $0)/strip-frontmatter.js $*
node $(dirname "$(readlink -f "$0")")/strip-frontmatter.js $*

69
package-lock.json generated
View File

@@ -1,16 +1,18 @@
{
"name": "markdown-to-html",
"name": "@doc-utils/markdown2html",
"version": "0.2.4",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "markdown-to-html",
"name": "@doc-utils/markdown2html",
"version": "0.2.4",
"dependencies": {
"bytefield-svg": "^1.6.1",
"dompurify": "^2.3.6",
"jsdom": "^20.0.1",
"katex": "^0.16.7",
"marked": "^4.1.1",
"marked": "^5.0.2",
"nomnoml": "^1.5.2",
"pikchr": "^0.0.5",
"prismjs": "^1.29.0",
@@ -18,18 +20,20 @@
"vega": "^5.22.1",
"yaml": "^2.2.2"
},
"bin": {
"markdown2html": "bin/markdown2html"
},
"devDependencies": {
"@types/dompurify": "^2.3.3",
"@types/jsdom": "^20.0.0",
"@types/katex": "^0.16.0",
"@types/luxon": "^3.1.0",
"@types/marked": "^4.0.3",
"@types/marked": "^5.0.0",
"@types/node": "^18.11.18",
"@types/prismjs": "^1.26.0",
"@types/qrcode": "^1.5.0",
"typescript": "^5.0.4"
},
"version": "0.1.3"
}
},
"node_modules/@tootallnate/once": {
"version": "2.0.0",
@@ -82,15 +86,15 @@
"dev": true
},
"node_modules/@types/marked": {
"version": "4.0.8",
"resolved": "https://registry.npmjs.org/@types/marked/-/marked-4.0.8.tgz",
"integrity": "sha512-HVNzMT5QlWCOdeuBsgXP8EZzKUf0+AXzN+sLmjvaB3ZlLqO+e4u0uXrdw9ub69wBKFs+c6/pA4r9sy6cCDvImw==",
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/@types/marked/-/marked-5.0.0.tgz",
"integrity": "sha512-YcZe50jhltsCq7rc9MNZC/4QB/OnA2Pd6hrOSTOFajtabN+38slqgDDCeE/0F83SjkKBQcsZUj7VLWR0H5cKRA==",
"dev": true
},
"node_modules/@types/node": {
"version": "18.16.3",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.3.tgz",
"integrity": "sha512-OPs5WnnT1xkCBiuQrZA4+YAV4HEJejmHneyraIaxsbev5yCEr6KMwINNFP9wQeFIw8FWcoTqF3vQsa5CDaI+8Q==",
"version": "18.16.6",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.6.tgz",
"integrity": "sha512-N7KINmeB8IN3vRR8dhgHEp+YpWvGFcpDoh5XZ8jB5a00AdFKCKEyyGTOPTddUf4JqU1ZKTVxkOxakDvchNVI2Q==",
"dev": true
},
"node_modules/@types/prismjs": {
@@ -950,14 +954,14 @@
"integrity": "sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA=="
},
"node_modules/marked": {
"version": "4.3.0",
"resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
"integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==",
"version": "5.0.2",
"resolved": "https://registry.npmjs.org/marked/-/marked-5.0.2.tgz",
"integrity": "sha512-TXksm9GwqXCRNbFUZmMtqNLvy3K2cQHuWmyBDLOrY1e6i9UvZpOTJXoz7fBjYkJkaUFzV9hBFxMuZSyQt8R6KQ==",
"bin": {
"marked": "bin/marked.js"
},
"engines": {
"node": ">= 12"
"node": ">= 18"
}
},
"node_modules/mime-db": {
@@ -985,9 +989,9 @@
"integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
},
"node_modules/node-fetch": {
"version": "2.6.9",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.9.tgz",
"integrity": "sha512-DJm/CJkZkRjKKj4Zi4BsKVZh3ValV5IR5s7LVZnW+6YMh0W1BfNA8XSs6DLMGYlId5F3KnA70uu2qepcR08Qqg==",
"version": "2.6.11",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.11.tgz",
"integrity": "sha512-4I6pdBY1EthSqDmJkiNk3JIT8cswwR9nfeW/cPdUagJYEQG7R95WRH74wpz7ma8Gh/9dI9FP+OU+0E4FvtA55w==",
"dependencies": {
"whatwg-url": "^5.0.0"
},
@@ -2011,15 +2015,15 @@
"dev": true
},
"@types/marked": {
"version": "4.0.8",
"resolved": "https://registry.npmjs.org/@types/marked/-/marked-4.0.8.tgz",
"integrity": "sha512-HVNzMT5QlWCOdeuBsgXP8EZzKUf0+AXzN+sLmjvaB3ZlLqO+e4u0uXrdw9ub69wBKFs+c6/pA4r9sy6cCDvImw==",
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/@types/marked/-/marked-5.0.0.tgz",
"integrity": "sha512-YcZe50jhltsCq7rc9MNZC/4QB/OnA2Pd6hrOSTOFajtabN+38slqgDDCeE/0F83SjkKBQcsZUj7VLWR0H5cKRA==",
"dev": true
},
"@types/node": {
"version": "18.16.3",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.3.tgz",
"integrity": "sha512-OPs5WnnT1xkCBiuQrZA4+YAV4HEJejmHneyraIaxsbev5yCEr6KMwINNFP9wQeFIw8FWcoTqF3vQsa5CDaI+8Q==",
"version": "18.16.6",
"resolved": "https://registry.npmjs.org/@types/node/-/node-18.16.6.tgz",
"integrity": "sha512-N7KINmeB8IN3vRR8dhgHEp+YpWvGFcpDoh5XZ8jB5a00AdFKCKEyyGTOPTddUf4JqU1ZKTVxkOxakDvchNVI2Q==",
"dev": true
},
"@types/prismjs": {
@@ -2647,9 +2651,9 @@
"integrity": "sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA=="
},
"marked": {
"version": "4.3.0",
"resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz",
"integrity": "sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A=="
"version": "5.0.2",
"resolved": "https://registry.npmjs.org/marked/-/marked-5.0.2.tgz",
"integrity": "sha512-TXksm9GwqXCRNbFUZmMtqNLvy3K2cQHuWmyBDLOrY1e6i9UvZpOTJXoz7fBjYkJkaUFzV9hBFxMuZSyQt8R6KQ=="
},
"mime-db": {
"version": "1.52.0",
@@ -2670,9 +2674,9 @@
"integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
},
"node-fetch": {
"version": "2.6.9",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.9.tgz",
"integrity": "sha512-DJm/CJkZkRjKKj4Zi4BsKVZh3ValV5IR5s7LVZnW+6YMh0W1BfNA8XSs6DLMGYlId5F3KnA70uu2qepcR08Qqg==",
"version": "2.6.11",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.11.tgz",
"integrity": "sha512-4I6pdBY1EthSqDmJkiNk3JIT8cswwR9nfeW/cPdUagJYEQG7R95WRH74wpz7ma8Gh/9dI9FP+OU+0E4FvtA55w==",
"requires": {
"whatwg-url": "^5.0.0"
},
@@ -3482,6 +3486,5 @@
"decamelize": "^1.2.0"
}
}
},
"version": "0.1.3"
}
}

View File

@@ -1,6 +1,6 @@
{
"name": "@doc-utils/markdown2html",
"version": "0.1.3",
"version": "0.2.4",
"publishConfig": {
"registry": "https://gitea.home.jbrumond.me/api/packages/doc-utils/npm/"
},
@@ -11,13 +11,13 @@
"bin": {
"markdown2html": "./bin/markdown2html"
},
"main": "./src/index.ts",
"main": "./build/index.js",
"devDependencies": {
"@types/dompurify": "^2.3.3",
"@types/jsdom": "^20.0.0",
"@types/katex": "^0.16.0",
"@types/luxon": "^3.1.0",
"@types/marked": "^4.0.3",
"@types/marked": "^5.0.0",
"@types/node": "^18.11.18",
"@types/prismjs": "^1.26.0",
"@types/qrcode": "^1.5.0",
@@ -28,7 +28,7 @@
"dompurify": "^2.3.6",
"jsdom": "^20.0.1",
"katex": "^0.16.7",
"marked": "^4.1.1",
"marked": "^5.0.2",
"nomnoml": "^1.5.2",
"pikchr": "^0.0.5",
"prismjs": "^1.29.0",

View File

@@ -68,11 +68,11 @@ foo:
# This is some markdown
`;
const { frontmatter, markdown } = process_frontmatter(raw_content);
const { frontmatter, document } = process_frontmatter(raw_content);
console.log(frontmatter.title); // "Example Markdown with front matter"
console.log(frontmatter.foo); // [ "bar", "baz" ]
console.log(markdown); // "\n# This is some markdown\n"
console.log(document); // "\n# This is some markdown\n"
```

View File

@@ -88,7 +88,5 @@ export function parse_attributes(text: string, fallback_id?: Lazy<string>) {
}
}
console.log(attrs);
return attrs;
}

11
src/base-url.ts Normal file
View File

@@ -0,0 +1,11 @@
import { marked } from 'marked';
import { MarkdownOptions } from './render';
export function base_url_walk_tokens(token: marked.Token, options: MarkdownOptions) {
if (options.base_url) {
if (token.type === 'link' || token.type === 'image') {
token.href = (new URL(token.href, options.base_url)).toString();
}
}
}

64
src/breadcrumb-nav.ts Normal file
View File

@@ -0,0 +1,64 @@
import { marked } from 'marked';
import { ParsedAttributes, parse_attributes } from './attrs';
import { MarkdownOptions } from './render';
// todo: deprecate this
export interface BreadcrumbNavToken extends marked.Tokens.Generic {
text: string;
attrs: ParsedAttributes;
items: marked.Token[][];
}
export function breadcrumb_nav_ext(renderer: marked.Renderer, opts: MarkdownOptions) : marked.TokenizerExtension & marked.RendererExtension {
return {
name: 'breadcrumb_nav',
level: 'block',
start: (src) => src.match(/^\/\/\//)?.index,
tokenizer(src, tokens) {
const rule = /^\/\/\/(\/*)([^\n]+)?(?:\n)((?:[^\/]|\/\/?(?!\/\1))+)\/\/\/\1/;
const match = rule.exec(src);
if (match) {
const token: BreadcrumbNavToken = {
type: 'breadcrumb_nav',
raw: match[0],
text: match[3],
attrs: parse_attributes(match[2] || ''),
tokens: [ ],
items: [ ],
};
const lines = match[3].trim().split('\n');
for (const line of lines) {
const tokens = this.lexer.inlineTokens(line, [ ]);
token.tokens.push(...tokens);
token.items.push(tokens);
}
return token;
}
},
renderer(token: BreadcrumbNavToken) {
return `<nav aria-label="breadcrumbs" ${token.attrs.html_attrs.join(' ')}>\n`
+ `\t<ol>\n`
+ '\t\t'
+ token.items.map((tokens, index) =>{
let item = '<li>\n';
if (index) {
item += '\t\t\t<span class="separator" aria-hidden="true">/</span>\n';
}
item += `\t\t\t${this.parser.parseInline(tokens, renderer)}\n`;
return item + '\t\t</li>';
}).join('\n\t\t')
+ '\n'
+ `\t</ol>\n`
+ `</nav>`;
}
};
}

View File

@@ -1,18 +1,26 @@
import * as yaml from 'yaml';
export function process_frontmatter(document: string, parse = true) {
if (! document.startsWith('---\n')) {
export function process_frontmatter(raw_document: string, parse = true) {
if (! raw_document.startsWith('---\n')) {
return {
frontmatter: null,
markdown: document,
document: raw_document,
};
}
const endIndex = document.slice(3).indexOf('\n---\n') + 3;
const frontmatterYaml = document.slice(3, endIndex);
const markdown = document.slice(endIndex + 4);
const frontmatter = parse ? frontmatterYaml : yaml.parse(frontmatterYaml);
const end_index = raw_document.slice(3).indexOf('\n---\n') + 3;
if (end_index === 2) {
return {
frontmatter: null,
document: raw_document,
};
}
return { frontmatter, markdown };
const formatter_yaml = raw_document.slice(3, end_index);
const document = raw_document.slice(end_index + 4);
const frontmatter = parse ? yaml.parse(formatter_yaml) : formatter_yaml;
return { frontmatter, document };
}

View File

@@ -2,13 +2,12 @@
import { JSDOM } from 'jsdom';
import createDOMPurify = require('dompurify');
export function sanitize_html(html: string) : string {
export type CustomElementHandling = createDOMPurify.Config['CUSTOM_ELEMENT_HANDLING'];
export function sanitize_html(html: string, custom_elements?: CustomElementHandling) : string {
const { window } = new JSDOM('');
const dom_purify = createDOMPurify(window as any as Window);
return dom_purify.sanitize(html, {
CUSTOM_ELEMENT_HANDLING: {
tagNameCheck: (tag_name) => tag_name === 'svg-icon',
attributeNameCheck: (attr_name) => attr_name === 'icon',
}
CUSTOM_ELEMENT_HANDLING: custom_elements,
});
}

View File

@@ -1,3 +1,3 @@
export { process_frontmatter } from './frontmatter';
export { render_markdown_to_html, MarkdownExtension, MarkdownOptions } from './render';
export { render_markdown_to_html, render_markdown_to_html_inline_sync, MarkdownExtension, MarkdownOptions } from './render';

150
src/pikchr.ts Normal file
View File

@@ -0,0 +1,150 @@
import { strip_svg } from './svg';
export function post_process_pikchr_svg(svg: string, size?: string) {
svg = strip_svg(svg);
// text
for (const [ color, regex ] of Object.entries(text_regex)) {
svg = svg.replace(regex, (_, $1) => `<text${$1}fill="${text_css_vars[color]}"`);
}
// shape fill
for (const [ color, regex ] of Object.entries(shape_fill_regex)) {
svg = svg.replace(regex, (_, $1) => `<path${$1}style="fill:${fill_css_vars[color]}`);
}
// arrow heads
for (const [ color, regex ] of Object.entries(arrow_head_regex)) {
svg = svg.replace(regex, `fill:${line_css_vars[color]}`);
}
// lines / boxes
for (const [ color, regex ] of Object.entries(line_regex)) {
svg = svg.replace(regex, `stroke:${line_css_vars[color]}`);
}
return svg;
}
type CSSVarColor
= 'black'
| 'red'
| 'orange'
| 'yellow'
| 'green'
| 'teal'
| 'pink'
| 'purple'
| 'blue'
| 'indigo'
| 'magenta'
| 'brown'
;
const text_regex: Record<CSSVarColor, RegExp> = {
black: /<text( | [^>]+ )fill="rgb\(0,0,0\)"/gi,
red: /<text( | [^>]+ )fill="rgb\(255,0,0\)"/gi,
orange: /<text( | [^>]+ )fill="rgb\(255,165,0\)"/gi,
yellow: /<text( | [^>]+ )fill="rgb\(255,255,0\)"/gi,
green: /<text( | [^>]+ )fill="rgb\(0,128,0\)"/gi,
teal: /<text( | [^>]+ )fill="rgb\(0,128,128\)"/gi,
pink: /<text( | [^>]+ )fill="rgb\(255,192,203\)"/gi,
purple: /<text( | [^>]+ )fill="rgb\(128,0,128\)"/gi,
blue: /<text( | [^>]+ )fill="rgb\(0,0,255\)"/gi,
indigo: /<text( | [^>]+ )fill="rgb\(75,0,130\)"/gi,
magenta: /<text( | [^>]+ )fill="rgb\(255,0,255\)"/gi,
brown: /<text( | [^>]+ )fill="rgb\(165,42,42\)"/gi,
};
const line_regex: Record<CSSVarColor, RegExp> = {
black: /stroke:rgb\(0,0,0\)/gi,
red: /stroke:rgb\(255,0,0\)/gi,
orange: /stroke:rgb\(255,165,0\)/gi,
yellow: /stroke:rgb\(255,255,0\)/gi,
green: /stroke:rgb\(0,128,0\)/gi,
teal: /stroke:rgb\(0,128,128\)/gi,
pink: /stroke:rgb\(255,192,203\)/gi,
purple: /stroke:rgb\(128,0,128\)/gi,
blue: /stroke:rgb\(0,0,255\)/gi,
indigo: /stroke:rgb\(75,0,130\)/gi,
magenta: /stroke:rgb\(255,0,255\)/gi,
brown: /stroke:rgb\(165,42,42\)/gi,
};
const shape_fill_regex = {
black: /<path( | [^>]+ )style="fill:rgb\(0,0,0\)/gi,
red: /<path( | [^>]+ )style="fill:rgb\(255,0,0\)/gi,
orange: /<path( | [^>]+ )style="fill:rgb\(255,165,0\)/gi,
yellow: /<path( | [^>]+ )style="fill:rgb\(255,255,0\)/gi,
green: /<path( | [^>]+ )style="fill:rgb\(0,128,0\)/gi,
teal: /<path( | [^>]+ )style="fill:rgb\(0,128,128\)/gi,
pink: /<path( | [^>]+ )style="fill:rgb\(255,192,203\)/gi,
purple: /<path( | [^>]+ )style="fill:rgb\(128,0,128\)/gi,
blue: /<path( | [^>]+ )style="fill:rgb\(0,0,255\)/gi,
indigo: /<path( | [^>]+ )style="fill:rgb\(75,0,130\)/gi,
magenta: /<path( | [^>]+ )style="fill:rgb\(255,0,255\)/gi,
brown: /<path( | [^>]+ )style="fill:rgb\(165,42,42\)/gi,
}
const arrow_head_regex: Record<CSSVarColor, RegExp> = {
black: /fill:rgb\(0,0,0\)/gi,
red: /fill:rgb\(255,0,0\)/gi,
orange: /fill:rgb\(255,165,0\)/gi,
yellow: /fill:rgb\(255,255,0\)/gi,
green: /fill:rgb\(0,128,0\)/gi,
teal: /fill:rgb\(0,128,128\)/gi,
pink: /fill:rgb\(255,192,203\)/gi,
purple: /fill:rgb\(128,0,128\)/gi,
blue: /fill:rgb\(0,0,255\)/gi,
indigo: /fill:rgb\(75,0,130\)/gi,
magenta: /fill:rgb\(255,0,255\)/gi,
brown: /fill:rgb\(165,42,42\)/gi,
};
const line_css_vars: Record<CSSVarColor, string> = {
black: 'var(--theme-line, currentcolor)',
red: 'var(--theme-chart-shape-red-line, currentcolor)',
orange: 'var(--theme-chart-shape-orange-line, currentcolor)',
yellow: 'var(--theme-chart-shape-yellow-line, currentcolor)',
green: 'var(--theme-chart-shape-green-line, currentcolor)',
teal: 'var(--theme-chart-shape-teal-line, currentcolor)',
pink: 'var(--theme-chart-shape-pink-line, currentcolor)',
purple: 'var(--theme-chart-shape-purple-line, currentcolor)',
blue: 'var(--theme-chart-shape-blue-line, currentcolor)',
indigo: 'var(--theme-chart-shape-indigo-line, currentcolor)',
magenta: 'var(--theme-chart-shape-magenta-line, currentcolor)',
brown: 'var(--theme-chart-shape-brown-line, currentcolor)',
};
const text_css_vars: Record<CSSVarColor, string> = {
black: 'var(--theme-text-body, currentcolor)',
red: 'var(--theme-chart-shape-red-line, currentcolor)',
orange: 'var(--theme-chart-shape-orange-line, currentcolor)',
yellow: 'var(--theme-chart-shape-yellow-line, currentcolor)',
green: 'var(--theme-chart-shape-green-line, currentcolor)',
teal: 'var(--theme-chart-shape-teal-line, currentcolor)',
pink: 'var(--theme-chart-shape-pink-line, currentcolor)',
purple: 'var(--theme-chart-shape-purple-line, currentcolor)',
blue: 'var(--theme-chart-shape-blue-line, currentcolor)',
indigo: 'var(--theme-chart-shape-indigo-line, currentcolor)',
magenta: 'var(--theme-chart-shape-magenta-line, currentcolor)',
brown: 'var(--theme-chart-shape-brown-line, currentcolor)',
};
const fill_css_vars: Record<CSSVarColor, string> = {
black: 'var(--theme-bg-heavy, transparent)',
red: 'var(--theme-chart-shape-red-fill, transparent)',
orange: 'var(--theme-chart-shape-orange-fill, transparent)',
yellow: 'var(--theme-chart-shape-yellow-fill, transparent)',
green: 'var(--theme-chart-shape-green-fill, transparent)',
teal: 'var(--theme-chart-shape-teal-fill, transparent)',
pink: 'var(--theme-chart-shape-pink-fill, transparent)',
purple: 'var(--theme-chart-shape-purple-fill, transparent)',
blue: 'var(--theme-chart-shape-blue-fill, transparent)',
indigo: 'var(--theme-chart-shape-indigo-fill, transparent)',
magenta: 'var(--theme-chart-shape-magenta-fill, transparent)',
brown: 'var(--theme-chart-shape-brown-fill, transparent)',
};

View File

@@ -4,11 +4,13 @@ import { create_renderer } from './renderer';
import { mark_ext } from './mark';
import { section_ext } from './section';
import { icon_ext } from './icon';
import { sanitize_html } from './html-sanitize';
import { CustomElementHandling, sanitize_html } from './html-sanitize';
import { katex_block_ext, katex_inline_ext } from './katex';
import { footnote_list_ext, footnote_ref_ext } from './footnotes';
import { description_list_ext } from './description-list';
import { resolve_async_bindings } from './async-steps';
import { breadcrumb_nav_ext } from './breadcrumb-nav';
import { base_url_walk_tokens } from './base-url';
export interface MarkdownOptions {
base_url?: string;
@@ -16,6 +18,7 @@ export interface MarkdownOptions {
inline?: boolean;
katex_macros?: Record<string, string>;
extensions?: MarkdownExtension[];
custom_elements?: CustomElementHandling;
}
export interface MarkdownExtension {
@@ -23,13 +26,36 @@ export interface MarkdownExtension {
}
export async function render_markdown_to_html(markdown: string, options: MarkdownOptions = { }) {
const marked_options: marked.MarkedOptions = {
baseUrl: options.base_url,
const marked_options = marked_opts(true, options);
const unsafe_html = options.inline
? marked.parseInline(markdown, marked_options)
: await marked.parse(markdown, marked_options).then(resolve_async_bindings);
return sanitize_html(unsafe_html, options.custom_elements);
}
export function render_markdown_to_html_inline_sync(markdown: string, options: MarkdownOptions = { }) {
const marked_options = marked_opts(false, options);
setup_marked(options, marked_options);
const unsafe_html = marked.parseInline(markdown, marked_options);
return sanitize_html(unsafe_html, options.custom_elements);
}
function marked_opts<T extends boolean>(async: T, options: MarkdownOptions) : marked.MarkedOptions & { async: T } {
return {
async,
breaks: options.breaks || false,
renderer: create_renderer(options),
mangle: false,
headerIds: false,
};
}
function setup_marked(options: MarkdownOptions, marked_options: marked.MarkedOptions) {
marked.use({
walkTokens(token) {
base_url_walk_tokens(token, options);
},
extensions: [
katex_block_ext(marked_options.renderer, options),
katex_inline_ext(marked_options.renderer, options),
@@ -39,6 +65,7 @@ export async function render_markdown_to_html(markdown: string, options: Markdow
description_list_ext(marked_options.renderer, options),
section_ext(marked_options.renderer, options),
icon_ext(marked_options.renderer, options),
breadcrumb_nav_ext(marked_options.renderer, options),
...(options.extensions || [ ]).map((ext) => {
return ext(marked_options.renderer, options);
}),
@@ -51,18 +78,4 @@ export async function render_markdown_to_html(markdown: string, options: Markdow
}
},
});
const unsafe_html = options.inline
? marked.parseInline(markdown, marked_options)
: await new Promise<string>((resolve, reject) => {
marked.parse(markdown, marked_options, (error, unsafe_html) => {
if (error) {
return reject(error);
}
resolve_async_bindings(unsafe_html).then(resolve, reject);
});
});
return sanitize_html(unsafe_html);
}

View File

@@ -14,6 +14,7 @@ import { bind_data_async } from './async-steps';
import { render_vega_spec } from './vega';
import { parse_attributes } from './attrs';
import { MarkdownOptions } from './render';
import { post_process_pikchr_svg } from './pikchr';
export function create_renderer(opts: MarkdownOptions) {
const renderer = new marked.Renderer();
@@ -27,23 +28,16 @@ export function create_renderer(opts: MarkdownOptions) {
}
function heading(renderer: marked.Renderer, opts: MarkdownOptions) {
return function(orig_text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string, slugger) {
return function(orig_text: string, level: 1 | 2 | 3 | 4 | 5 | 6, raw: string) {
let { text, id, html_attrs } = parse_attributes(raw);
if (! id) {
id = slugger.slug(text);
html_attrs.push(`id="${id}"`);
if (id) {
text += `\n<a class="heading-anchor" href="#${id}">`
+ `\n\t\t${icons.link}`
+ `\n\t\t<span style="display: none">Section titled ${text}</span>`
+ `\n\t</a>`;
}
return `
<h${level} ${html_attrs.join(' ')}>
${text}
<a class="heading-anchor" href="#${id}">
${icons.link}
<span style="display: none">Section titled ${text}</span>
</a>
</h${level}>
`;
return `\n<h${level} ${html_attrs.join(' ')}>\n\t${text}\n</h${level}>`;
};
}
@@ -89,6 +83,8 @@ function code(renderer: marked.Renderer, opts: MarkdownOptions) {
case 'bash:samp': {
// Find the first newline that is not preceeded by a "\"
const end_of_input = /(?<!\\)(?:\r\n|\r|\n)/.exec(code);
// todo: handling for multi-line heredocs?
// If there is no such newline, the whole content is input
if (! end_of_input) {
@@ -194,7 +190,7 @@ function code(renderer: marked.Renderer, opts: MarkdownOptions) {
const arg_pattern = /^(?:[a-zA-Z0-9_:-]+|"(?:[^"\n]|(?<=\\)")*")/;
function parse_code_args(text: string) {
function parse_code_args(text = '') {
const args: string[] = [ ];
text = text.trim();
@@ -275,23 +271,3 @@ function post_process_nomnoml_svg(svg: string, size?: string) {
return svg;
}
const svg_text_fill_rgb_000 = /\b<text fill="rgb\(0,0,0\)"/gi;
const svg_fill_rgb_000 = /fill:rgb\(0,0,0\)/gi;
const svg_stroke_rgb_000 = /stroke:rgb\(0,0,0\)/gi;
// todo: css variables
function post_process_pikchr_svg(svg: string, size?: string) {
svg = strip_svg(svg);
// text
svg = svg.replace(svg_text_fill_rgb_000, '<text fill="var(--theme-text-body, currentcolor)"');
// arrow heads
svg = svg.replace(svg_fill_rgb_000, 'fill:var(--theme-line, currentcolor)');
// lines / boxes
svg = svg.replace(svg_stroke_rgb_000, 'stroke:var(--theme-line, currentcolor)');
return svg;
}

View File

@@ -1,18 +1,27 @@
// note: fallback colors come from "category10" scheme
// https://vega.github.io/vega/docs/schemes/#category10
// todo: css variables
export const chart_data_colors = [
'var(--theme-chart-data-0, #1f77b4)',
'var(--theme-chart-data-1, #ff7f0e)',
'var(--theme-chart-data-2, #2ca02c)',
'var(--theme-chart-data-3, #d62728)',
'var(--theme-chart-data-4, #9467bd)',
'var(--theme-chart-data-5, #8c564b)',
'var(--theme-chart-data-6, #e377c2)',
'var(--theme-chart-data-7, #7f7f7f)',
'var(--theme-chart-data-8, #bcbd22)',
'var(--theme-chart-data-9, #17becf)',
'var(--theme-chart-shape-red-fill, #feaea5)',
'var(--theme-chart-shape-orange-fill, #fad6bc)',
'var(--theme-chart-shape-yellow-fill, #fffec6)',
'var(--theme-chart-shape-green-fill, #d6f9d5)',
'var(--theme-chart-shape-teal-fill, #b0ebe9)',
'var(--theme-chart-shape-pink-fill, #ffcae2)',
'var(--theme-chart-shape-purple-fill, #efdeff)',
'var(--theme-chart-shape-blue-fill, #caebff)',
'var(--theme-chart-shape-indigo-fill, #c2d6f9)',
'var(--theme-chart-shape-magenta-fill, #ebb5cd)',
'var(--theme-chart-shape-brown-fill, #e1c3b8)',
'var(--theme-chart-shape-red-line, #ff806d)',
'var(--theme-chart-shape-orange-line, #ffb780)',
'var(--theme-chart-shape-yellow-line, #e1dc18)',
'var(--theme-chart-shape-green-line, #66cc66)',
'var(--theme-chart-shape-teal-line, #66cdcc)',
'var(--theme-chart-shape-pink-line, #ff99cb)',
'var(--theme-chart-shape-purple-line, #cc99fe)',
'var(--theme-chart-shape-blue-line, #66cbff)',
'var(--theme-chart-shape-indigo-line, #6295ee)',
'var(--theme-chart-shape-magenta-line, #cc6698)',
'var(--theme-chart-shape-brown-line, #bf8c71)',
];
export function* chart_data_color_generator() : Generator<string, never> {