writr - npm Package Compare versions
Comparing version 3.0.1 to 3.1.0
| import { Processor } from 'unified'; | ||
| import { type HTMLReactParserOptions } from 'html-react-parser'; | ||
| import type React from 'react'; | ||
| type WritrOptions = { | ||
| openai?: string; | ||
| emoji?: boolean; | ||
| toc?: boolean; | ||
| slug?: boolean; | ||
| highlight?: boolean; | ||
| gfm?: boolean; | ||
| renderOptions?: RenderOptions; | ||
| }; | ||
@@ -16,2 +14,3 @@ type RenderOptions = { | ||
| gfm?: boolean; | ||
| math?: boolean; | ||
| }; | ||
@@ -24,4 +23,7 @@ declare class Writr { | ||
| render(markdown: string, options?: RenderOptions): Promise<string>; | ||
| renderSync(markdown: string, options?: RenderOptions): string; | ||
| renderReact(markdown: string, options?: RenderOptions, reactParseOptions?: HTMLReactParserOptions): Promise<string | React.JSX.Element | React.JSX.Element[]>; | ||
| renderReactSync(markdown: string, options?: RenderOptions, reactParseOptions?: HTMLReactParserOptions): string | React.JSX.Element | React.JSX.Element[]; | ||
| private createProcessor; | ||
| } | ||
| export { Writr, type WritrOptions, type RenderOptions }; |
@@ -8,4 +8,7 @@ import { unified } from 'unified'; | ||
| import remarkToc from 'remark-toc'; | ||
| import remarkMath from 'remark-math'; | ||
| import rehypeKatex from 'rehype-katex'; | ||
| import remarkGfm from 'remark-gfm'; | ||
| import remarkEmoji from 'remark-emoji'; | ||
| import parse from 'html-react-parser'; | ||
| class Writr { | ||
@@ -19,2 +22,4 @@ engine = unified() | ||
| .use(rehypeSlug) // Add slugs to headings in HTML | ||
| .use(remarkMath) // Add math support | ||
| .use(rehypeKatex) // Add math support | ||
| .use(rehypeHighlight) // Apply syntax highlighting | ||
@@ -24,7 +29,10 @@ .use(rehypeStringify); // Stringify HTML | ||
| openai: undefined, | ||
| emoji: true, | ||
| toc: true, | ||
| slug: true, | ||
| highlight: true, | ||
| gfm: true, | ||
| renderOptions: { | ||
| emoji: true, | ||
| toc: true, | ||
| slug: true, | ||
| highlight: true, | ||
| gfm: true, | ||
| math: true, | ||
| }, | ||
| }; | ||
@@ -34,4 +42,6 @@ constructor(options) { | ||
| this._options = { ...this._options, ...options }; | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
| this.engine = this.createProcessor(this._options); | ||
| if (this._options.renderOptions) { | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
| this.engine = this.createProcessor(this._options.renderOptions); | ||
| } | ||
| } | ||
@@ -46,3 +56,3 @@ } | ||
| if (options) { | ||
| options = { ...this._options, ...options }; | ||
| options = { ...this._options.renderOptions, ...options }; | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
@@ -58,2 +68,25 @@ engine = this.createProcessor(options); | ||
| } | ||
| renderSync(markdown, options) { | ||
| try { | ||
| let { engine } = this; | ||
| if (options) { | ||
| options = { ...this._options.renderOptions, ...options }; | ||
| // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment | ||
| engine = this.createProcessor(options); | ||
| } | ||
| const file = engine.processSync(markdown); | ||
| return String(file); | ||
| } | ||
| catch (error) { | ||
| throw new Error(`Failed to render markdown: ${error.message}`); | ||
| } | ||
| } | ||
| async renderReact(markdown, options, reactParseOptions) { | ||
| const html = await this.render(markdown, options); | ||
| return parse(html, reactParseOptions); | ||
| } | ||
| renderReactSync(markdown, options, reactParseOptions) { | ||
| const html = this.renderSync(markdown, options); | ||
| return parse(html, reactParseOptions); | ||
| } | ||
| createProcessor(options) { | ||
@@ -82,2 +115,2 @@ const processor = unified().use(remarkParse); | ||
| export { Writr }; | ||
| //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoid3JpdHIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvd3JpdHIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFDLE9BQU8sRUFBWSxNQUFNLFNBQVMsQ0FBQztBQUMzQyxPQUFPLFdBQVcsTUFBTSxjQUFjLENBQUM7QUFDdkMsT0FBTyxZQUFZLE1BQU0sZUFBZSxDQUFDO0FBQ3pDLE9BQU8sVUFBVSxNQUFNLGFBQWEsQ0FBQztBQUNyQyxPQUFPLGVBQWUsTUFBTSxrQkFBa0IsQ0FBQztBQUMvQyxPQUFPLGVBQWUsTUFBTSxrQkFBa0IsQ0FBQztBQUMvQyxPQUFPLFNBQVMsTUFBTSxZQUFZLENBQUM7QUFDbkMsT0FBTyxTQUFTLE1BQU0sWUFBWSxDQUFDO0FBQ25DLE9BQU8sV0FBVyxNQUFNLGNBQWMsQ0FBQztBQW1CdkMsTUFBTSxLQUFLO0lBQ0gsTUFBTSxHQUFHLE9BQU8sRUFBRTtTQUN2QixHQUFHLENBQUMsV0FBVyxDQUFDO1NBQ2hCLEdBQUcsQ0FBQyxTQUFTLENBQUMsQ0FBQywrQkFBK0I7U0FDOUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDLHdCQUF3QjtTQUN2QyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUMsb0JBQW9CO1NBQ3JDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQywyQkFBMkI7U0FDN0MsR0FBRyxDQUFDLFVBQVUsQ0FBQyxDQUFDLGdDQUFnQztTQUNoRCxHQUFHLENBQUMsZUFBZSxDQUFDLENBQUMsNEJBQTRCO1NBQ2pELEdBQUcsQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDLGlCQUFpQjtJQUV4QixRQUFRLEdBQWlCO1FBQ3pDLE1BQU0sRUFBRSxTQUFTO1FBQ2pCLEtBQUssRUFBRSxJQUFJO1FBQ1gsR0FBRyxFQUFFLElBQUk7UUFDVCxJQUFJLEVBQUUsSUFBSTtRQUNWLFNBQVMsRUFBRSxJQUFJO1FBQ2YsR0FBRyxFQUFFLElBQUk7S0FDVCxDQUFDO0lBRUYsWUFBWSxPQUFzQjtRQUNqQyxJQUFJLE9BQU8sRUFBRSxDQUFDO1lBQ2IsSUFBSSxDQUFDLFFBQVEsR0FBRyxFQUFDLEdBQUcsSUFBSSxDQUFDLFFBQVEsRUFBRSxHQUFHLE9BQU8sRUFBQyxDQUFDO1lBQy9DLG1FQUFtRTtZQUNuRSxJQUFJLENBQUMsTUFBTSxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQ25ELENBQUM7SUFDRixDQUFDO0lBRUQsSUFBVyxPQUFPO1FBQ2pCLE9BQU8sSUFBSSxDQUFDLFFBQVEsQ0FBQztJQUN0QixDQUFDO0lBRUQsS0FBSyxDQUFDLE1BQU0sQ0FBQyxRQUFnQixFQUFFLE9BQXVCO1FBQ3JELElBQUksQ0FBQztZQUNKLElBQUksRUFBQyxNQUFNLEVBQUMsR0FBRyxJQUFJLENBQUM7WUFDcEIsSUFBSSxPQUFPLEVBQUUsQ0FBQztnQkFDYixPQUFPLEdBQUcsRUFBQyxHQUFHLElBQUksQ0FBQyxRQUFRLEVBQUUsR0FBRyxPQUFPLEVBQUMsQ0FBQztnQkFDekMsbUVBQW1FO2dCQUNuRSxNQUFNLEdBQUcsSUFBSSxDQUFDLGVBQWUsQ0FBQyxPQUFPLENBQUMsQ0FBQztZQUN4QyxDQUFDO1lBRUQsTUFBTSxJQUFJLEdBQUcsTUFBTSxNQUFNLENBQUMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO1lBQzVDLE9BQU8sTUFBTSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3JCLENBQUM7UUFBQyxPQUFPLEtBQUssRUFBRSxDQUFDO1lBQ2hCLE1BQU0sSUFBSSxLQUFLLENBQUMsOEJBQStCLEtBQWUsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO1FBQzNFLENBQUM7SUFDRixDQUFDO0lBRU8sZUFBZSxDQUFDLE9BQXFDO1FBQzVELE1BQU0sU0FBUyxHQUFHLE9BQU8sRUFBRSxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQztRQUU3QyxJQUFJLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUNqQixTQUFTLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxDQUFDO1FBQzFCLENBQUM7UUFFRCxJQUFJLE9BQU8sQ0FBQyxHQUFHLEVBQUUsQ0FBQztZQUNqQixTQUFTLENBQUMsR0FBRyxDQUFDLFNBQVMsRUFBRSxFQUFDLE9BQU8sRUFBRSx1QkFBdUIsRUFBQyxDQUFDLENBQUM7UUFDOUQsQ0FBQztRQUVELElBQUksT0FBTyxDQUFDLEtBQUssRUFBRSxDQUFDO1lBQ25CLFNBQVMsQ0FBQyxHQUFHLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDNUIsQ0FBQztRQUVELFNBQVMsQ0FBQyxHQUFHLENBQUMsWUFBWSxDQUFDLENBQUM7UUFFNUIsSUFBSSxPQUFPLENBQUMsSUFBSSxFQUFFLENBQUM7WUFDbEIsU0FBUyxDQUFDLEdBQUcsQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUMzQixDQUFDO1FBRUQsSUFBSSxPQUFPLENBQUMsU0FBUyxFQUFFLENBQUM7WUFDdkIsU0FBUyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUNoQyxDQUFDO1FBRUQsU0FBUyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUUvQixPQUFPLFNBQVMsQ0FBQztJQUNsQixDQUFDO0NBQ0Q7QUFFRCxPQUFPLEVBQUMsS0FBSyxFQUF3QyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHt1bmlmaWVkLCBQcm9jZXNzb3J9IGZyb20gJ3VuaWZpZWQnO1xuaW1wb3J0IHJlbWFya1BhcnNlIGZyb20gJ3JlbWFyay1wYXJzZSc7XG5pbXBvcnQgcmVtYXJrUmVoeXBlIGZyb20gJ3JlbWFyay1yZWh5cGUnO1xuaW1wb3J0IHJlaHlwZVNsdWcgZnJvbSAncmVoeXBlLXNsdWcnO1xuaW1wb3J0IHJlaHlwZUhpZ2hsaWdodCBmcm9tICdyZWh5cGUtaGlnaGxpZ2h0JztcbmltcG9ydCByZWh5cGVTdHJpbmdpZnkgZnJvbSAncmVoeXBlLXN0cmluZ2lmeSc7XG5pbXBvcnQgcmVtYXJrVG9jIGZyb20gJ3JlbWFyay10b2MnO1xuaW1wb3J0IHJlbWFya0dmbSBmcm9tICdyZW1hcmstZ2ZtJztcbmltcG9ydCByZW1hcmtFbW9qaSBmcm9tICdyZW1hcmstZW1vamknO1xuXG50eXBlIFdyaXRyT3B0aW9ucyA9IHtcblx0b3BlbmFpPzogc3RyaW5nOyAvLyBPcGVuYWkgYXBpIGtleSAoZGVmYXVsdDogdW5kZWZpbmVkKVxuXHRlbW9qaT86IGJvb2xlYW47IC8vIEVtb2ppIHN1cHBvcnQgKGRlZmF1bHQ6IHRydWUpXG5cdHRvYz86IGJvb2xlYW47IC8vIFRhYmxlIG9mIGNvbnRlbnRzIGdlbmVyYXRpb24gKGRlZmF1bHQ6IHRydWUpXG5cdHNsdWc/OiBib29sZWFuOyAvLyBTbHVnIGdlbmVyYXRpb24gKGRlZmF1bHQ6IHRydWUpXG5cdGhpZ2hsaWdodD86IGJvb2xlYW47IC8vIENvZGUgaGlnaGxpZ2h0aW5nIChkZWZhdWx0OiB0cnVlKVxuXHRnZm0/OiBib29sZWFuOyAvLyBHaXRodWIgZmxhdm9yIG1hcmtkb3duIChkZWZhdWx0OiB0cnVlKVxufTtcblxudHlwZSBSZW5kZXJPcHRpb25zID0ge1xuXHRlbW9qaT86IGJvb2xlYW47IC8vIEVtb2ppIHN1cHBvcnQgKGRlZmF1bHQ6IHRydWUpXG5cdHRvYz86IGJvb2xlYW47IC8vIFRhYmxlIG9mIGNvbnRlbnRzIGdlbmVyYXRpb24gKGRlZmF1bHQ6IHRydWUpXG5cdHNsdWc/OiBib29sZWFuOyAvLyBTbHVnIGdlbmVyYXRpb24gKGRlZmF1bHQ6IHRydWUpXG5cdGhpZ2hsaWdodD86IGJvb2xlYW47IC8vIENvZGUgaGlnaGxpZ2h0aW5nIChkZWZhdWx0OiB0cnVlKVxuXHRnZm0/OiBib29sZWFuOyAvLyBHaXRodWIgZmxhdm9yIG1hcmtkb3duIChkZWZhdWx0OiB0cnVlKVxufTtcblxuY2xhc3MgV3JpdHIge1xuXHRwdWJsaWMgZW5naW5lID0gdW5pZmllZCgpXG5cdFx0LnVzZShyZW1hcmtQYXJzZSlcblx0XHQudXNlKHJlbWFya0dmbSkgLy8gVXNlIEdpdEh1YiBGbGF2b3JlZCBNYXJrZG93blxuXHRcdC51c2UocmVtYXJrVG9jKSAvLyBBZGQgdGFibGUgb2YgY29udGVudHNcblx0XHQudXNlKHJlbWFya0Vtb2ppKSAvLyBBZGQgZW1vamkgc3VwcG9ydFxuXHRcdC51c2UocmVtYXJrUmVoeXBlKSAvLyBDb252ZXJ0IG1hcmtkb3duIHRvIEhUTUxcblx0XHQudXNlKHJlaHlwZVNsdWcpIC8vIEFkZCBzbHVncyB0byBoZWFkaW5ncyBpbiBIVE1MXG5cdFx0LnVzZShyZWh5cGVIaWdobGlnaHQpIC8vIEFwcGx5IHN5bnRheCBoaWdobGlnaHRpbmdcblx0XHQudXNlKHJlaHlwZVN0cmluZ2lmeSk7IC8vIFN0cmluZ2lmeSBIVE1MXG5cblx0cHJpdmF0ZSByZWFkb25seSBfb3B0aW9uczogV3JpdHJPcHRpb25zID0ge1xuXHRcdG9wZW5haTogdW5kZWZpbmVkLFxuXHRcdGVtb2ppOiB0cnVlLFxuXHRcdHRvYzogdHJ1ZSxcblx0XHRzbHVnOiB0cnVlLFxuXHRcdGhpZ2hsaWdodDogdHJ1ZSxcblx0XHRnZm06IHRydWUsXG5cdH07XG5cblx0Y29uc3RydWN0b3Iob3B0aW9ucz86IFdyaXRyT3B0aW9ucykge1xuXHRcdGlmIChvcHRpb25zKSB7XG5cdFx0XHR0aGlzLl9vcHRpb25zID0gey4uLnRoaXMuX29wdGlvbnMsIC4uLm9wdGlvbnN9O1xuXHRcdFx0Ly8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnNhZmUtYXNzaWdubWVudFxuXHRcdFx0dGhpcy5lbmdpbmUgPSB0aGlzLmNyZWF0ZVByb2Nlc3Nvcih0aGlzLl9vcHRpb25zKTtcblx0XHR9XG5cdH1cblxuXHRwdWJsaWMgZ2V0IG9wdGlvbnMoKTogV3JpdHJPcHRpb25zIHtcblx0XHRyZXR1cm4gdGhpcy5fb3B0aW9ucztcblx0fVxuXG5cdGFzeW5jIHJlbmRlcihtYXJrZG93bjogc3RyaW5nLCBvcHRpb25zPzogUmVuZGVyT3B0aW9ucyk6IFByb21pc2U8c3RyaW5nPiB7XG5cdFx0dHJ5IHtcblx0XHRcdGxldCB7ZW5naW5lfSA9IHRoaXM7XG5cdFx0XHRpZiAob3B0aW9ucykge1xuXHRcdFx0XHRvcHRpb25zID0gey4uLnRoaXMuX29wdGlvbnMsIC4uLm9wdGlvbnN9O1xuXHRcdFx0XHQvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVuc2FmZS1hc3NpZ25tZW50XG5cdFx0XHRcdGVuZ2luZSA9IHRoaXMuY3JlYXRlUHJvY2Vzc29yKG9wdGlvbnMpO1xuXHRcdFx0fVxuXG5cdFx0XHRjb25zdCBmaWxlID0gYXdhaXQgZW5naW5lLnByb2Nlc3MobWFya2Rvd24pO1xuXHRcdFx0cmV0dXJuIFN0cmluZyhmaWxlKTtcblx0XHR9IGNhdGNoIChlcnJvcikge1xuXHRcdFx0dGhyb3cgbmV3IEVycm9yKGBGYWlsZWQgdG8gcmVuZGVyIG1hcmtkb3duOiAkeyhlcnJvciBhcyBFcnJvcikubWVzc2FnZX1gKTtcblx0XHR9XG5cdH1cblxuXHRwcml2YXRlIGNyZWF0ZVByb2Nlc3NvcihvcHRpb25zOiBSZW5kZXJPcHRpb25zIHwgV3JpdHJPcHRpb25zKTogYW55IHtcblx0XHRjb25zdCBwcm9jZXNzb3IgPSB1bmlmaWVkKCkudXNlKHJlbWFya1BhcnNlKTtcblxuXHRcdGlmIChvcHRpb25zLmdmbSkge1xuXHRcdFx0cHJvY2Vzc29yLnVzZShyZW1hcmtHZm0pO1xuXHRcdH1cblxuXHRcdGlmIChvcHRpb25zLnRvYykge1xuXHRcdFx0cHJvY2Vzc29yLnVzZShyZW1hcmtUb2MsIHtoZWFkaW5nOiAndG9jfHRhYmxlIG9mIGNvbnRlbnRzJ30pO1xuXHRcdH1cblxuXHRcdGlmIChvcHRpb25zLmVtb2ppKSB7XG5cdFx0XHRwcm9jZXNzb3IudXNlKHJlbWFya0Vtb2ppKTtcblx0XHR9XG5cblx0XHRwcm9jZXNzb3IudXNlKHJlbWFya1JlaHlwZSk7XG5cblx0XHRpZiAob3B0aW9ucy5zbHVnKSB7XG5cdFx0XHRwcm9jZXNzb3IudXNlKHJlaHlwZVNsdWcpO1xuXHRcdH1cblxuXHRcdGlmIChvcHRpb25zLmhpZ2hsaWdodCkge1xuXHRcdFx0cHJvY2Vzc29yLnVzZShyZWh5cGVIaWdobGlnaHQpO1xuXHRcdH1cblxuXHRcdHByb2Nlc3Nvci51c2UocmVoeXBlU3RyaW5naWZ5KTtcblxuXHRcdHJldHVybiBwcm9jZXNzb3I7XG5cdH1cbn1cblxuZXhwb3J0IHtXcml0ciwgdHlwZSBXcml0ck9wdGlvbnMsIHR5cGUgUmVuZGVyT3B0aW9uc307XG5cbiJdfQ== | ||
| //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"writr.js","sourceRoot":"","sources":["../src/writr.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAY,MAAM,SAAS,CAAC;AAC3C,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAO,eAAe,MAAM,kBAAkB,CAAC;AAC/C,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,SAAS,MAAM,YAAY,CAAC;AACnC,OAAO,WAAW,MAAM,cAAc,CAAC;AACvC,OAAO,KAAoC,MAAM,mBAAmB,CAAC;AAiBrE,MAAM,KAAK;IACH,MAAM,GAAG,OAAO,EAAE;SACvB,GAAG,CAAC,WAAW,CAAC;SAChB,GAAG,CAAC,SAAS,CAAC,CAAC,+BAA+B;SAC9C,GAAG,CAAC,SAAS,CAAC,CAAC,wBAAwB;SACvC,GAAG,CAAC,WAAW,CAAC,CAAC,oBAAoB;SACrC,GAAG,CAAC,YAAY,CAAC,CAAC,2BAA2B;SAC7C,GAAG,CAAC,UAAU,CAAC,CAAC,gCAAgC;SAChD,GAAG,CAAC,UAAU,CAAC,CAAC,mBAAmB;SACnC,GAAG,CAAC,WAAW,CAAC,CAAC,mBAAmB;SACpC,GAAG,CAAC,eAAe,CAAC,CAAC,4BAA4B;SACjD,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,iBAAiB;IAExB,QAAQ,GAAiB;QACzC,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE;YACd,KAAK,EAAE,IAAI;YACX,GAAG,EAAE,IAAI;YACT,IAAI,EAAE,IAAI;YACV,SAAS,EAAE,IAAI;YACf,GAAG,EAAE,IAAI;YACT,IAAI,EAAE,IAAI;SACV;KACD,CAAC;IAEF,YAAY,OAAsB;QACjC,IAAI,OAAO,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,GAAG,EAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,GAAG,OAAO,EAAC,CAAC;YAC/C,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAC;gBACjC,mEAAmE;gBACnE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;YACjE,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAW,OAAO;QACjB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,OAAuB;QACrD,IAAI,CAAC;YACJ,IAAI,EAAC,MAAM,EAAC,GAAG,IAAI,CAAC;YACpB,IAAI,OAAO,EAAE,CAAC;gBACb,OAAO,GAAG,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,OAAO,EAAC,CAAC;gBACvD,mEAAmE;gBACnE,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACxC,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC5C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,8BAA+B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3E,CAAC;IACF,CAAC;IAED,UAAU,CAAC,QAAgB,EAAE,OAAuB;QACnD,IAAI,CAAC;YACJ,IAAI,EAAC,MAAM,EAAC,GAAG,IAAI,CAAC;YACpB,IAAI,OAAO,EAAE,CAAC;gBACb,OAAO,GAAG,EAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,OAAO,EAAC,CAAC;gBACvD,mEAAmE;gBACnE,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACxC,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,8BAA+B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3E,CAAC;IACF,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,QAAgB,EAAE,OAAuB,EAAE,iBAA0C;QACtG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAElD,OAAO,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAED,eAAe,CAAC,QAAgB,EAAE,OAAuB,EAAE,iBAA0C;QACpG,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAChD,OAAO,KAAK,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IACvC,CAAC;IAEO,eAAe,CAAC,OAAsB;QAC7C,MAAM,SAAS,GAAG,OAAO,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE7C,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACjB,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;QAED,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YACjB,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,EAAC,OAAO,EAAE,uBAAuB,EAAC,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YACnB,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAC5B,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAE5B,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YAClB,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAChC,CAAC;QAED,SAAS,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAE/B,OAAO,SAAS,CAAC;IAClB,CAAC;CACD;AAED,OAAO,EAAC,KAAK,EAAwC,CAAC","sourcesContent":["import {unified, Processor} from 'unified';\nimport remarkParse from 'remark-parse';\nimport remarkRehype from 'remark-rehype';\nimport rehypeSlug from 'rehype-slug';\nimport rehypeHighlight from 'rehype-highlight';\nimport rehypeStringify from 'rehype-stringify';\nimport remarkToc from 'remark-toc';\nimport remarkMath from 'remark-math';\nimport rehypeKatex from 'rehype-katex';\nimport remarkGfm from 'remark-gfm';\nimport remarkEmoji from 'remark-emoji';\nimport parse, {type HTMLReactParserOptions} from 'html-react-parser';\nimport type React from 'react';\n\ntype WritrOptions = {\n\topenai?: string; // Openai api key (default: undefined)\n\trenderOptions?: RenderOptions; // Default render options (default: undefined)\n};\n\ntype RenderOptions = {\n\temoji?: boolean; // Emoji support (default: true)\n\ttoc?: boolean; // Table of contents generation (default: true)\n\tslug?: boolean; // Slug generation (default: true)\n\thighlight?: boolean; // Code highlighting (default: true)\n\tgfm?: boolean; // Github flavor markdown (default: true)\n\tmath?: boolean; // Math support (default: true)\n};\n\nclass Writr {\n\tpublic engine = unified()\n\t\t.use(remarkParse)\n\t\t.use(remarkGfm) // Use GitHub Flavored Markdown\n\t\t.use(remarkToc) // Add table of contents\n\t\t.use(remarkEmoji) // Add emoji support\n\t\t.use(remarkRehype) // Convert markdown to HTML\n\t\t.use(rehypeSlug) // Add slugs to headings in HTML\n\t\t.use(remarkMath) // Add math support\n\t\t.use(rehypeKatex) // Add math support\n\t\t.use(rehypeHighlight) // Apply syntax highlighting\n\t\t.use(rehypeStringify); // Stringify HTML\n\n\tprivate readonly _options: WritrOptions = {\n\t\topenai: undefined,\n\t\trenderOptions: {\n\t\t\temoji: true,\n\t\t\ttoc: true,\n\t\t\tslug: true,\n\t\t\thighlight: true,\n\t\t\tgfm: true,\n\t\t\tmath: true,\n\t\t},\n\t};\n\n\tconstructor(options?: WritrOptions) {\n\t\tif (options) {\n\t\t\tthis._options = {...this._options, ...options};\n\t\t\tif (this._options.renderOptions) {\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\t\tthis.engine = this.createProcessor(this._options.renderOptions);\n\t\t\t}\n\t\t}\n\t}\n\n\tpublic get options(): WritrOptions {\n\t\treturn this._options;\n\t}\n\n\tasync render(markdown: string, options?: RenderOptions): Promise<string> {\n\t\ttry {\n\t\t\tlet {engine} = this;\n\t\t\tif (options) {\n\t\t\t\toptions = {...this._options.renderOptions, ...options};\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\t\tengine = this.createProcessor(options);\n\t\t\t}\n\n\t\t\tconst file = await engine.process(markdown);\n\t\t\treturn String(file);\n\t\t} catch (error) {\n\t\t\tthrow new Error(`Failed to render markdown: ${(error as Error).message}`);\n\t\t}\n\t}\n\n\trenderSync(markdown: string, options?: RenderOptions): string {\n\t\ttry {\n\t\t\tlet {engine} = this;\n\t\t\tif (options) {\n\t\t\t\toptions = {...this._options.renderOptions, ...options};\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\t\tengine = this.createProcessor(options);\n\t\t\t}\n\n\t\t\tconst file = engine.processSync(markdown);\n\t\t\treturn String(file);\n\t\t} catch (error) {\n\t\t\tthrow new Error(`Failed to render markdown: ${(error as Error).message}`);\n\t\t}\n\t}\n\n\tasync renderReact(markdown: string, options?: RenderOptions, reactParseOptions?: HTMLReactParserOptions): Promise<string | React.JSX.Element | React.JSX.Element[]> {\n\t\tconst html = await this.render(markdown, options);\n\n\t\treturn parse(html, reactParseOptions);\n\t}\n\n\trenderReactSync(markdown: string, options?: RenderOptions, reactParseOptions?: HTMLReactParserOptions): string | React.JSX.Element | React.JSX.Element[] {\n\t\tconst html = this.renderSync(markdown, options);\n\t\treturn parse(html, reactParseOptions);\n\t}\n\n\tprivate createProcessor(options: RenderOptions): any {\n\t\tconst processor = unified().use(remarkParse);\n\n\t\tif (options.gfm) {\n\t\t\tprocessor.use(remarkGfm);\n\t\t}\n\n\t\tif (options.toc) {\n\t\t\tprocessor.use(remarkToc, {heading: 'toc|table of contents'});\n\t\t}\n\n\t\tif (options.emoji) {\n\t\t\tprocessor.use(remarkEmoji);\n\t\t}\n\n\t\tprocessor.use(remarkRehype);\n\n\t\tif (options.slug) {\n\t\t\tprocessor.use(rehypeSlug);\n\t\t}\n\n\t\tif (options.highlight) {\n\t\t\tprocessor.use(rehypeHighlight);\n\t\t}\n\n\t\tprocessor.use(rehypeStringify);\n\n\t\treturn processor;\n\t}\n}\n\nexport {Writr, type WritrOptions, type RenderOptions};\n\n"]} |
| { | ||
| "name": "writr", | ||
| "version": "3.0.1", | ||
| "version": "3.1.0", | ||
| "description": "Markdown Rendering Simplified", | ||
| "type": "module", | ||
| "exports": "./dist/index.js", | ||
| "types": "./dist/index.d.ts", | ||
| "exports": "./dist/writr.js", | ||
| "types": "./dist/writr.d.ts", | ||
| "repository": "https://github.com/jaredwray/writr.git", | ||
@@ -36,3 +36,7 @@ "author": "Jared Wray <me@jaredwray.com>", | ||
| "remark", | ||
| "rehype" | ||
| "rehype", | ||
| "react", | ||
| "react-component", | ||
| "react-markdown", | ||
| "markdown-to-react" | ||
| ], | ||
@@ -48,3 +52,6 @@ "scripts": { | ||
| "dependencies": { | ||
| "html-react-parser": "^5.1.8", | ||
| "react": "^18.2.0", | ||
| "rehype-highlight": "^7.0.0", | ||
| "rehype-katex": "^7.0.0", | ||
| "rehype-slug": "^6.0.0", | ||
@@ -54,2 +61,3 @@ "rehype-stringify": "^10.0.0", | ||
| "remark-gfm": "^4.0.0", | ||
| "remark-math": "^6.0.0", | ||
| "remark-parse": "^11.0.0", | ||
@@ -63,2 +71,3 @@ "remark-rehype": "^11.1.0", | ||
| "@types/node": "^20.10.5", | ||
| "@types/react": "^18.2.61", | ||
| "@vitest/coverage-v8": "^1.1.0", | ||
@@ -65,0 +74,0 @@ "docula": "^0.4.0", |
@@ -10,2 +10,3 @@  | ||
| [](https://npmjs.com/package/writr) | ||
| [](https://npmjs.com/package/writr) | ||
@@ -21,9 +22,10 @@ --- | ||
| * Up and Rendering in seconds with a simple API. | ||
| * Easily Render to `React` or `HTML`. | ||
| * Generates a Table of Contents for your markdown files (remark-toc). | ||
| * Slug generation for your markdown files (rehype-slug). | ||
| * Code Highlighting (rehype-highlight). | ||
| * Math Support (rehype-katex). | ||
| * Markdown to HTML (rehype-stringify). | ||
| * Github Flavor Markdown (remark-gfm). | ||
| * Emoji Support (remark-emoji). | ||
| * Generation of Keywords, Descriptions, and Translations using AI. | ||
@@ -84,19 +86,25 @@ ## Getting Started | ||
| ```js | ||
| interface WritrOptions { | ||
| openai?: string; // openai api key (default: undefined) | ||
| emoji?: boolean; // emoji support (default: true) | ||
| toc?: boolean; // table of contents generation (default: true) | ||
| slug?: boolean; // slug generation (default: true) | ||
| highlight?: boolean; // code highlighting (default: true) | ||
| gfm?: boolean; // github flavor markdown (default: true) | ||
| } | ||
| ``` | ||
| You can access the `WritrOptions` from the instance of Writr. Here is an example of WritrOptions. | ||
| You can access the `WritrOptions` from the instance of Writr. | ||
| ```javascript | ||
| import { Writr, WritrOptions } from 'writr'; | ||
| const writrOptions = { | ||
| openai: 'your-api-key', // openai api key (default: undefined) | ||
| renderOptions: { | ||
| emoji: true, | ||
| toc: true, | ||
| slug: true, | ||
| highlight: true, | ||
| gfm: true, | ||
| math: true | ||
| } | ||
| }; | ||
| const writr = new Writr(writrOptions); | ||
| ``` | ||
| ### `.engine` | ||
| Accessing the underlying engine for this instance of Writr. This is a `Processor<Root, Root, Root, undefined, undefined>` fromt the unified `.use()` function. You can use this to add additional plugins to the engine. | ||
| ### `.options` | ||
@@ -125,15 +133,35 @@ | ||
| ### `.renderTranslation(markdown: string, langCode: string, options?: RenderOptions): Promise<string>` | ||
| ### `.renderSync(markdown: string, options?: RenderOptions): string` | ||
| Rendering markdown to HTML. the options are based on RenderOptions. Which you can access from the Writr instance. | ||
| Rendering markdown to HTML synchronously. the options are based on RenderOptions. Which you can access from the Writr instance. The parameters are the same as the `.render()` function. | ||
| ```javascript | ||
| import { Writr } from 'writr'; | ||
| const writr = new Writr(); | ||
| const markdown = `# Hello World ::-):\n\n This is a test.`; | ||
| const html = writr.renderSync(markdown); // <h1>Hello World 🙂</h1><p>This is a test.</p> | ||
| ``` | ||
| ### `.keywords(markdown: string): Promise<string[]>` | ||
| ### '.renderReact(markdown: string, options?: RenderOptions, reactOptions?: HTMLReactParserOptions): Promise<React.JSX.Element>' | ||
| AI Generation of Keywords that can be used for SEO on your HTML. | ||
| Rendering markdown to React. The options are based on RenderOptions and now HTMLReactParserOptions from `html-react-parser`. | ||
| ### `.description(markdown: string): Promise<string>` | ||
| ```javascript | ||
| import { Writr } from 'writr'; | ||
| const writr = new Writr(); | ||
| const markdown = `# Hello World ::-):\n\n This is a test.`; | ||
| const reactElement = await writr.renderReact(markdown); // Will return a React.JSX.Element | ||
| ``` | ||
| AI Generation of a Description that can be used for SEO on your HTML. | ||
| ### '.renderReactSync(markdown: string, options?: RenderOptions, reactOptions?: HTMLReactParserOptions): React.JSX.Element' | ||
| Rendering markdown to React. The options are based on RenderOptions and now HTMLReactParserOptions from `html-react-parser`. | ||
| ```javascript | ||
| import { Writr } from 'writr'; | ||
| const writr = new Writr(); | ||
| const markdown = `# Hello World ::-):\n\n This is a test.`; | ||
| const reactElement = writr.renderReactSync(markdown); // Will return a React.JSX.Element | ||
| ``` | ||
| ## Code of Conduct and Contributing | ||
@@ -140,0 +168,0 @@ [Code of Conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md) guidelines. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by35.24%
24396
- Lines of code
- increased by35%
135
- Number of lines in readme file
- increased by19.86%
169
Worsened metrics
- Dependency count
- increased by40%
14
- Dev dependency count
- increased by12.5%
9
Dependency changes
+ Addedhtml-react-parser@^5.1.8
+ Addedreact@^18.2.0
+ Addedrehype-katex@^7.0.0
+ Addedremark-math@^6.0.0
+ Added@types/katex@0.16.7(transitive)
+ Addedcommander@8.3.0(transitive)
+ Addeddom-serializer@2.0.0(transitive)
+ Addeddomelementtype@2.3.0(transitive)
+ Addeddomhandler@5.0.3(transitive)
+ Addeddomutils@3.1.0(transitive)
+ Addedentities@4.5.0(transitive)
+ Addedhast-util-from-dom@5.0.0(transitive)
+ Addedhast-util-from-html@2.0.3(transitive)
+ Addedhast-util-from-html-isomorphic@2.0.0(transitive)
+ Addedhast-util-from-parse5@8.0.1(transitive)
+ Addedhast-util-parse-selector@4.0.0(transitive)
+ Addedhastscript@8.0.0(transitive)
+ Addedhtml-dom-parser@5.0.10(transitive)
+ Addedhtml-react-parser@5.1.16(transitive)
+ Addedhtmlparser2@9.1.0(transitive)
+ Addedinline-style-parser@0.2.3(transitive)
+ Addedjs-tokens@4.0.0(transitive)
+ Addedkatex@0.16.11(transitive)
+ Addedloose-envify@1.4.0(transitive)
+ Addedmdast-util-math@3.0.0(transitive)
+ Addedmicromark-extension-math@3.1.0(transitive)
+ Addedparse5@7.1.2(transitive)
+ Addedreact@18.3.1(transitive)
+ Addedreact-property@2.0.2(transitive)
+ Addedrehype-katex@7.0.1(transitive)
+ Addedremark-math@6.0.0(transitive)
+ Addedstyle-to-js@1.1.14(transitive)
+ Addedstyle-to-object@1.0.7(transitive)
+ Addedunist-util-remove-position@5.0.0(transitive)
+ Addedvfile-location@5.0.3(transitive)
+ Addedweb-namespaces@2.0.1(transitive)