Compare commits
	
		
			16 Commits
		
	
	
		
			v0.2.5
			...
			4cfeb23982
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 4cfeb23982 | |||
| 2051cb6644 | |||
| 02b9e94d3e | |||
| 43e15a90a9 | |||
| ea133cb0a7 | |||
| dff6c31481 | |||
| 64c1cdb715 | |||
| 950e04ae57 | |||
| 0330c0ec71 | |||
| bc031e8639 | |||
| b016f77c51 | |||
| e127195eaa | |||
| 71809455e2 | |||
| 21dbcad44f | |||
| 873aefcc6c | |||
| 5f5cd286e7 | 
							
								
								
									
										36
									
								
								.gitea/workflows/build-and-pubilsh.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										36
									
								
								.gitea/workflows/build-and-pubilsh.yaml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,36 @@ | ||||
|  | ||||
| name: Build and publish | ||||
|  | ||||
| on: | ||||
| # - workflow_dispatch | ||||
|   push: | ||||
|     branches: | ||||
|     - master | ||||
|  | ||||
| jobs: | ||||
|   build-and-publish: | ||||
|     runs-on: ubuntu-latest | ||||
|     env: | ||||
|       NPM_PUBLISH_TOKEN: ${{ secrets.NPM_TOKEN }} | ||||
|     steps: | ||||
|       - name: Check out the repo | ||||
|         uses: actions/checkout@v3 | ||||
|  | ||||
|       - name: Use Node.js 20 | ||||
|         uses: actions/setup-node@v3 | ||||
|         with: | ||||
|           node-version: 20 | ||||
|  | ||||
|       - name: Login to package registry | ||||
|         run: | | ||||
|           npm config set @doc-utils:registry https://gitea.jbrumond.me/api/packages/doc-utils/npm/ | ||||
|           npm config set -- '//gitea.jbrumond.me/api/packages/doc-utils/npm/:_authToken' "$NPM_PUBLISH_TOKEN" | ||||
|  | ||||
|       - name: Install dependencies | ||||
|         run: npm ci | ||||
|  | ||||
|       - name: Compile TypeScript | ||||
|         run: npm run tsc | ||||
|  | ||||
|       - name: Publish package | ||||
|         run: npm publish | ||||
							
								
								
									
										40
									
								
								.gitea/workflows/build-and-test.yaml
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										40
									
								
								.gitea/workflows/build-and-test.yaml
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,40 @@ | ||||
|  | ||||
| name: Build and test | ||||
|  | ||||
| on: | ||||
|   # push: | ||||
|   #   branches: | ||||
|   #   - master | ||||
|   pull_request: | ||||
|     branches: | ||||
|     - master | ||||
|  | ||||
| jobs: | ||||
|   build-and-test: | ||||
|     runs-on: ubuntu-latest | ||||
|     strategy: | ||||
|       matrix: | ||||
|         node-version: [18.x, 20.x] | ||||
|     steps: | ||||
|       - name: Check out the repo | ||||
|         uses: actions/checkout@v3 | ||||
|  | ||||
|       - name: Use Node.js ${{ matrix.node-version }} | ||||
|         uses: actions/setup-node@v3 | ||||
|         with: | ||||
|           node-version: ${{ matrix.node-version }} | ||||
|  | ||||
|       - name: Login to package registry | ||||
|         run: | | ||||
|           npm config set @doc-utils:registry https://gitea.jbrumond.me/api/packages/doc-utils/npm/ | ||||
|           npm config set -- '//gitea.jbrumond.me/api/packages/doc-utils/npm/:_authToken' "$NPM_PUBLISH_TOKEN" | ||||
|  | ||||
|       - name: Install dependencies | ||||
|         run: npm ci | ||||
|  | ||||
|       - name: Compile TypeScript | ||||
|         run: npm run tsc | ||||
|  | ||||
|       # todo: tests | ||||
|       - name: Run tests | ||||
|         run: exit 0 | ||||
							
								
								
									
										4
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										4
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							| @@ -1,12 +1,12 @@ | ||||
| { | ||||
|   "name": "@doc-utils/markdown2html", | ||||
|   "version": "0.2.5", | ||||
|   "version": "0.3.5", | ||||
|   "lockfileVersion": 2, | ||||
|   "requires": true, | ||||
|   "packages": { | ||||
|     "": { | ||||
|       "name": "@doc-utils/markdown2html", | ||||
|       "version": "0.2.5", | ||||
|       "version": "0.3.5", | ||||
|       "dependencies": { | ||||
|         "bytefield-svg": "^1.6.1", | ||||
|         "dompurify": "^2.3.6", | ||||
|   | ||||
| @@ -1,6 +1,6 @@ | ||||
| { | ||||
|   "name": "@doc-utils/markdown2html", | ||||
|   "version": "0.2.5", | ||||
|   "version": "0.3.5", | ||||
|   "publishConfig": { | ||||
|     "registry": "https://gitea.home.jbrumond.me/api/packages/doc-utils/npm/" | ||||
|   }, | ||||
|   | ||||
| @@ -1,64 +0,0 @@ | ||||
|  | ||||
| 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>`; | ||||
| 		} | ||||
| 	}; | ||||
| } | ||||
| @@ -3,14 +3,19 @@ import { marked } from 'marked'; | ||||
| import { MarkdownOptions } from './render'; | ||||
|  | ||||
| export interface DescriptionListToken extends marked.Tokens.Generic { | ||||
| 	type: 'description_list'; | ||||
| 	items: (DescriptionTermToken | DescriptionDetailToken)[]; | ||||
| } | ||||
|  | ||||
| export type DescriptionElemToken = DescriptionTermToken | DescriptionDetailToken; | ||||
|  | ||||
| export interface DescriptionTermToken extends marked.Tokens.Generic { | ||||
| 	type: 'description_term'; | ||||
| 	text: string; | ||||
| } | ||||
|  | ||||
| export interface DescriptionDetailToken extends marked.Tokens.Generic { | ||||
| 	type: 'description_detail'; | ||||
| 	text: string; | ||||
| } | ||||
|  | ||||
| @@ -18,72 +23,106 @@ export function description_list_ext(renderer: marked.Renderer, opts: MarkdownOp | ||||
| 	return { | ||||
| 		name: 'description_list', | ||||
| 		level: 'block', | ||||
| 		start: (src) => src.match(/^:[:#-]/)?.index, | ||||
| 		start: (src) => src.match(/^: /)?.index, | ||||
| 		tokenizer(src, tokens) { | ||||
| 			const rule = /^(?::[:#-](?:\s[^\n]*)?(?:\n|$))+/; | ||||
| 			const match = rule.exec(src); | ||||
| 			const start = src.match(/^: /)?.index; | ||||
| 			const lines = src.slice(start).split(/\n/g); | ||||
| 			const token: DescriptionListToken = { | ||||
| 				type: 'description_list', | ||||
| 				raw: '', | ||||
| 				items: [ ] | ||||
| 			}; | ||||
|  | ||||
| 			if (match) { | ||||
| 				const token: DescriptionListToken = { | ||||
| 					type: 'description_list', | ||||
| 					raw: match[0], | ||||
| 					items: [ ] | ||||
| 				}; | ||||
| 			let current: DescriptionElemToken; | ||||
| 			const render_current = () => { | ||||
| 				if (current) { | ||||
| 					this.lexer.blockTokens(current.text, current.tokens); | ||||
| 					current = null; | ||||
| 				} | ||||
| 			}; | ||||
|  | ||||
| 				const items = token.raw.trim().split('\n'); | ||||
| 				const raw_buffer: string[] = [ ]; | ||||
| 				const text_buffer: string[] = [ ]; | ||||
| 			for (const line of lines) { | ||||
| 				// Skip empty lines | ||||
| 				if (! line.trim()) { | ||||
| 					token.raw += line + '\n'; | ||||
|  | ||||
| 				const flush_buffer = () => { | ||||
| 					if (! raw_buffer.length) { | ||||
| 						return; | ||||
| 					if (current) { | ||||
| 						current.raw += line + '\n'; | ||||
| 						current.text += '\n'; | ||||
| 					} | ||||
|  | ||||
| 					// Grab the second character from the first line to determine the | ||||
| 					// token type (should be "#" or "-") | ||||
| 					const type = raw_buffer[0][1] === '#' ? 'description_term' : 'description_detail'; | ||||
| 					 | ||||
| 					const sub_token: (DescriptionTermToken | DescriptionDetailToken) = { | ||||
| 						type, | ||||
| 						raw: raw_buffer.join('\n'), | ||||
| 						text: text_buffer.join('\n'), | ||||
| 						tokens: [ ], | ||||
| 					}; | ||||
|  | ||||
| 					raw_buffer.length = 0; | ||||
| 					text_buffer.length = 0; | ||||
|  | ||||
| 					this.lexer.blockTokens(sub_token.text, sub_token.tokens); | ||||
| 					token.items.push(sub_token); | ||||
| 				}; | ||||
|  | ||||
| 				for (const line of items) { | ||||
| 					const rule = /^:([:#-])(?:\s([^\n]*))?(?:\n|$)/; | ||||
| 					const match = rule.exec(line); | ||||
| 		 | ||||
| 					if (match) { | ||||
| 						if (match[1] !== ':') { | ||||
| 							flush_buffer(); | ||||
| 						} | ||||
|  | ||||
| 						raw_buffer.push(match[0]); | ||||
| 						text_buffer.push(match[2]); | ||||
| 					} | ||||
| 					continue; | ||||
| 				} | ||||
|  | ||||
| 				flush_buffer(); | ||||
| 				// If the line starts immediately with a colon, it is a <dt> | ||||
| 				if (line.startsWith(': ')) { | ||||
| 					render_current(); | ||||
| 					token.raw += line + '\n'; | ||||
| 					token.items.push( | ||||
| 						current = { | ||||
| 							type: 'description_term', | ||||
| 							raw: line, | ||||
| 							text: line.slice(2), | ||||
| 							tokens: [ ], | ||||
| 						} | ||||
| 					); | ||||
| 					continue; | ||||
| 				} | ||||
|  | ||||
| 				// If the line starts with a colon after an indent, it is a <dd> | ||||
| 				if (line.startsWith('  : ')) { | ||||
| 					render_current(); | ||||
| 					token.raw += line + '\n'; | ||||
| 					token.items.push( | ||||
| 						current = { | ||||
| 							type: 'description_detail', | ||||
| 							raw: line, | ||||
| 							text: line.slice(4), | ||||
| 							tokens: [ ], | ||||
| 						} | ||||
| 					); | ||||
| 					continue; | ||||
| 				} | ||||
|  | ||||
| 				// If the line starts with (at least) two indents, it is a child | ||||
| 				// of the current element | ||||
| 				if (line.startsWith('    ')) { | ||||
| 					token.raw += line + '\n'; | ||||
| 					current.raw += '\n' + line; | ||||
| 					current.text += '\n' + line.slice(current.type === 'description_term' ? 2 : 4); | ||||
| 					continue; | ||||
| 				} | ||||
|  | ||||
| 				// If the line starts with one indent, it is a child of the current | ||||
| 				// <dt> (but is not allowed after a <dd>) | ||||
| 				if (line.startsWith('  ')) { | ||||
| 					if (current.type !== 'description_term') { | ||||
| 						render_current(); | ||||
| 						break; | ||||
| 					} | ||||
|  | ||||
| 					token.raw += line + '\n'; | ||||
| 					current.raw += '\n' + line; | ||||
| 					current.text += '\n' + line.slice(2); | ||||
| 					continue; | ||||
| 				} | ||||
|  | ||||
| 				// If the line starts any other way, it is the start of new content | ||||
| 				// and we are done parsing | ||||
| 				render_current(); | ||||
| 				break; | ||||
| 			} | ||||
| 			 | ||||
| 			render_current(); | ||||
|  | ||||
| 			if (token.items.length) { | ||||
| 				return token; | ||||
| 			} | ||||
| 		}, | ||||
| 		renderer(token: DescriptionListToken) { | ||||
| 			const items = token.items.map((item) => { | ||||
| 				const tag = item.type === 'description_term' ? 'dt' : 'dd'; | ||||
| 				return ` | ||||
| 					<${tag}> | ||||
| 						${this.parser.parse(item.tokens)} | ||||
| 					</${tag}> | ||||
| 				`; | ||||
| 				return `<${tag}>${this.parser.parse(item.tokens)}</${tag}>`; | ||||
| 			}); | ||||
|  | ||||
| 			return `<dl>${items.join('')}</dl>`; | ||||
|   | ||||
							
								
								
									
										33
									
								
								src/embed.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										33
									
								
								src/embed.ts
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,33 @@ | ||||
|  | ||||
| import type { marked } from 'marked'; | ||||
| import { MarkdownOptions } from './render'; | ||||
|  | ||||
| export interface EmbedToken extends marked.Tokens.Generic { | ||||
| 	media_type: string; | ||||
| 	href: string; | ||||
| } | ||||
|  | ||||
| export function embed_ext(renderer: marked.Renderer, opts: MarkdownOptions) : marked.TokenizerExtension & marked.RendererExtension { | ||||
| 	return { | ||||
| 		name: 'embed', | ||||
| 		level: 'inline', | ||||
| 		start: (src) => src.match(/\{&/)?.index, | ||||
| 		tokenizer(src, tokens) { | ||||
| 			const rule = /^\{&\s+([^\s]+):\s*([^\s]+)\s+&\}/; | ||||
| 			const match = rule.exec(src); | ||||
|  | ||||
| 			if (match) { | ||||
| 				return { | ||||
| 					type: 'embed', | ||||
| 					raw: match[0], | ||||
| 					media_type: match[1], | ||||
| 					href: match[2], | ||||
| 					tokens: [ ] | ||||
| 				}; | ||||
| 			} | ||||
| 		}, | ||||
| 		renderer(token: EmbedToken) { | ||||
| 			return `<embed type="${token.media_type}" src="${token.href}"></embed>`; | ||||
| 		} | ||||
| 	}; | ||||
| } | ||||
| @@ -23,7 +23,7 @@ export function footnote_ref_ext(renderer: marked.Renderer, opts: MarkdownOption | ||||
| 		level: 'inline', | ||||
| 		start: (src) => src.match(/\[\^/)?.index, | ||||
| 		tokenizer(src, tokens) { | ||||
| 			const rule = /^\[\^([a-zA-Z0-9-._§]+)]/; | ||||
| 			const rule = /^\[\^([a-zA-Z0-9-\._, §]+)]/; | ||||
| 			const match = rule.exec(src); | ||||
|  | ||||
| 			if (match) { | ||||
| @@ -68,7 +68,7 @@ export function footnote_list_ext(renderer: marked.Renderer, opts: MarkdownOptio | ||||
| 			}; | ||||
|  | ||||
| 			let remaining = src; | ||||
| 			const prefix_rule = /^\[\^([a-zA-Z0-9\._§-]+)]:/; | ||||
| 			const prefix_rule = /^\[\^([a-zA-Z0-9\., _§-]+)]:/; | ||||
| 			const whitespace_rule = /^\s*(?:\n|$)/; | ||||
|  | ||||
| 			if (! prefix_rule.test(src)) { | ||||
|   | ||||
| @@ -9,5 +9,6 @@ export function sanitize_html(html: string, custom_elements?: CustomElementHandl | ||||
| 	const dom_purify = createDOMPurify(window as any as Window); | ||||
| 	return dom_purify.sanitize(html, { | ||||
| 		CUSTOM_ELEMENT_HANDLING: custom_elements, | ||||
| 		ADD_TAGS: [ 'embed', 'object', 'video', 'audio', 'iframe' ], | ||||
| 	}); | ||||
| } | ||||
|   | ||||
							
								
								
									
										4
									
								
								src/prism/http.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								src/prism/http.ts
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,4 @@ | ||||
|  | ||||
| import { languages } from 'prismjs'; | ||||
|  | ||||
| languages.http['request-line'].pattern = /^(?:CONNECT|DELETE|GET|HEAD|QUERY|OPTIONS|PATCH|POST|PRI|PUT|SEARCH|TRACE)\s(?:https?:\/\/|\/)\S*\sHTTP\/[\d.]+/m; | ||||
| @@ -4,6 +4,7 @@ import load_languages = require('prismjs/components/index'); | ||||
|  | ||||
| load_languages(); | ||||
| require('./wasm'); | ||||
| require('./http'); | ||||
|  | ||||
| // hooks.add('after-tokenize', (env) => { | ||||
| // 	//  | ||||
|   | ||||
| @@ -9,8 +9,8 @@ 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'; | ||||
| import { embed_ext } from './embed'; | ||||
|  | ||||
| export interface MarkdownOptions { | ||||
| 	base_url?: string; | ||||
| @@ -27,6 +27,7 @@ export interface MarkdownExtension { | ||||
|  | ||||
| export async function render_markdown_to_html(markdown: string, options: MarkdownOptions = { }) { | ||||
| 	const marked_options = marked_opts(options); | ||||
| 	setup_marked(options, marked_options); | ||||
| 	const unsafe_html = options.inline | ||||
| 		? marked.parseInline(markdown, marked_options) | ||||
| 		: marked.parse(markdown, marked_options); | ||||
| @@ -64,7 +65,7 @@ function setup_marked(options: MarkdownOptions, marked_options: marked.MarkedOpt | ||||
| 			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), | ||||
| 			embed_ext(marked_options.renderer, options), | ||||
| 			...(options.extensions || [ ]).map((ext) => { | ||||
| 				return ext(marked_options.renderer, options); | ||||
| 			}), | ||||
|   | ||||
| @@ -29,7 +29,7 @@ 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) { | ||||
| 		let { text, id, html_attrs } = parse_attributes(raw); | ||||
| 		let { text, id, html_attrs } = parse_attributes(orig_text); | ||||
| 		if (id) { | ||||
| 			text += `\n<a class="heading-anchor" href="#${id}">` | ||||
| 				+ `\n\t\t${icons.link}` | ||||
| @@ -37,7 +37,7 @@ function heading(renderer: marked.Renderer, opts: MarkdownOptions) { | ||||
| 				+ `\n\t</a>`; | ||||
| 		} | ||||
|  | ||||
| 		return `\n<h${level} ${html_attrs.join(' ')}>\n\t${text}\n</h${level}>`; | ||||
| 		return `\n<h${level} ${html_attrs.join(' ')}>\n\t${text}\n</h${level}>\n`; | ||||
| 	}; | ||||
| } | ||||
|  | ||||
| @@ -153,6 +153,10 @@ function code(renderer: marked.Renderer, opts: MarkdownOptions) { | ||||
| 				return figure(binding); | ||||
| 			}; | ||||
|  | ||||
| 			case 'yaml:calendar': { | ||||
| 				// todo | ||||
| 			}; | ||||
| 	 | ||||
| 			default: | ||||
| 				return figure(`<pre class="language-${args[0] || 'txt'}">${render_prism(code, args[0])}</pre>`); | ||||
| 		} | ||||
|   | ||||
		Reference in New Issue
	
	Block a user