deno.land / x / lume@v2.1.4 / plugins / markdown.ts

نووسراو ببینە
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
import { markdownIt, markdownItAttrs, markdownItDeflist, MarkdownItOptions,} from "../deps/markdown_it.ts";import loader from "../core/loaders/text.ts";import { merge } from "../core/utils/object.ts";
import type Site from "../core/site.ts";import type { Engine } from "../core/renderer.ts";
export interface Options { /** The list of extensions this plugin applies to */ extensions?: string[];
/** Options passed to markdown-it library */ options?: MarkdownItOptions;
/** * The list of markdown-it plugins to use * @default `[markdownItAttrs, markdownItDeflist]` */ plugins?: unknown[];
/** To modify existing rules or new custom rules */ // deno-lint-ignore no-explicit-any rules?: Record<string, (...args: any[]) => any>;
/** Set `false` to remove the default plugins */ useDefaultPlugins?: boolean;}
// Default optionsexport const defaults: Options = { extensions: [".md", ".markdown"], options: { html: true, }, plugins: [], rules: {}, useDefaultPlugins: true,};
const defaultPlugins = [ markdownItAttrs, markdownItDeflist,];
interface MarkdownItEngine { render: (input: string, env?: Record<string, unknown>) => string;}
/** Template engine to render Markdown files */export class MarkdownEngine implements Engine { engine: MarkdownItEngine;
constructor(engine: MarkdownItEngine) { this.engine = engine; }
deleteCache() {}
render( content: string, data?: Record<string, unknown>, filename?: string, ): string { return this.renderComponent(content, data, filename); }
renderComponent( content: unknown, data?: Record<string, unknown>, filename?: string, ): string { if (typeof content !== "string") { content = String(content); } return this.engine.render(content as string, { filename, data }); }
addHelper() {}}
/** Register the plugin to support Markdown */export default function (userOptions?: Options) { const options = merge(defaults, userOptions);
if (options.useDefaultPlugins) { options.plugins.unshift(...defaultPlugins); }
return function (site: Site) { const engine = markdownIt(options.options);
// Disable indented code blocks by default engine.disable("code");
// Register markdown-it plugins options.plugins.forEach((plugin) => Array.isArray(plugin) ? engine.use(...plugin) : engine.use(plugin) );
// Hook to add markdown-it plugins site.hooks.addMarkdownItPlugin = (plugin, ...options) => { engine.use(plugin, ...options); };
// Register custom rules for (const [name, rule] of Object.entries(options.rules)) { engine.renderer.rules[name] = rule; }
// Hook to add custom rules site.hooks.addMarkdownItRule = (name, rule) => { engine.renderer.rules[name] = rule; };
site.hooks.markdownIt = (callback) => callback(engine);
// Load the pages site.loadPages(options.extensions, { loader, engine: new MarkdownEngine(engine), });
// Register the md filter site.filter("md", filter);
function filter(string: string, inline = false): string { return inline ? engine.renderInline(string?.toString() || "").trim() : engine.render(string?.toString() || "").trim(); } };}
/** Extends Helpers interface */declare global { namespace Lume { export interface Helpers { /** @see https://lume.land/plugins/markdown/ */ md: (string: string, inline?: boolean) => string; } }}
lume

Version Info

Tagged at
5 months ago