Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
@nlux/markdown
Advanced tools
A lightweight and fast markdown parser used by nlux that can be used to parse markdown text streams into DOM.
A lightweight JS/TS library that can be used to parse markdown streams as they are being read or generated.
It can be useful for LLM-powered applications that need to parse markdown streams in real-time.
This package is part of the NLUX UI toolkit for AI ecosystem.
import {
MarkdownStreamParser,
MarkdownStreamParserOptions,
createMarkdownStreamParser,
} from "@nlux/markdown";
const options: MarkdownStreamParserOptions = {
// markdownLinkTarget?: 'blank' | 'self'; // default: 'blank'
// syntaxHighlighter: (( Highlighter from @nlux/highlighter )), // default: undefined — for code blocks syntax highlighting
// showCodeBlockCopyButton?: boolean, // default: true — for code blocks
// skipStreamingAnimation?: boolean, // default: false
// streamingAnimationSpeed?: number, // default: 10 ( milliseconds )
// waitTimeBeforeStreamCompletion?: number | 'never', // default: 2000 ( milliseconds )
// onComplete: () => console.log("Parsing complete"), // triggered after the end of the stream
};
const domElement = document.querySelector(".markdown-container");
const mdStreamParser: MarkdownStreamParser = createMarkdownStreamParser(
domElement!,
options,
);
// On each chunk of markdown
mdStreamParser.next("## Hello World");
// To call when the markdown stream is complete
// This indicates to the parser that now additional text will be added
mdStreamParser.complete();
import { parseMdSnapshot } from "@nlux/markdown";
const parsedMarkdown = parseMdSnapshot(snapshot, options);
export type MarkdownStreamParser = {
next(value: string): void;
complete(): void;
};
export type MarkdownStreamParserOptions = {
markdownLinkTarget?: 'blank' | 'self';
syntaxHighlighter?: HighlighterExtension;
skipStreamingAnimation?: boolean;
streamingAnimationSpeed?: number;
waitTimeBeforeStreamCompletion?: number | 'never';
showCodeBlockCopyButton?: boolean;
onComplete?: () => void;
};
export type SnapshotParser = (
snapshot: string,
options?: {
syntaxHighlighter?: HighlighterExtension,
htmlSanitizer?: SanitizerExtension;
markdownLinkTarget?: 'blank' | 'self',
showCodeBlockCopyButton?: boolean;
skipStreamingAnimation?: boolean;
},
) => string;
FAQs
A lightweight and fast markdown parser used by nlux that can be used to parse markdown text streams into DOM.
The npm package @nlux/markdown receives a total of 76 weekly downloads. As such, @nlux/markdown popularity was classified as not popular.
We found that @nlux/markdown demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.