micromark-util-types

What is micromark-util-types?

The micromark-util-types package provides TypeScript types for micromark, a markdown parser. These types help in defining and working with various constructs and utilities within the micromark ecosystem.

What are micromark-util-types's main functionalities?

Token

Defines a token, which is a fundamental unit in the parsing process. Tokens represent segments of the input text with specific types and positions.

const token: Token = { type: 'text', start: { line: 1, column: 1, offset: 0 }, end: { line: 1, column: 5, offset: 4 }, content: 'text' };

Point

Defines a point in the source text, which is used to mark positions such as the start and end of tokens.

const point: Point = { line: 1, column: 1, offset: 0 };

CompileContext

Defines the context used during the compilation phase, providing methods and properties to manage the state and process of converting tokens into the final output.

const compileContext: CompileContext = { sliceSerialize: (token) => 'serialized', stack: [], enter: () => {}, exit: () => {} };

Other packages similar to micromark-util-types

remark

Remark is a markdown processor powered by plugins. It provides a comprehensive set of tools for parsing, transforming, and compiling markdown. Unlike micromark-util-types, which focuses on types for micromark, remark offers a full-fledged processing pipeline with extensive plugin support.

markdown-it

Markdown-it is a markdown parser with a focus on speed and extensibility. It provides a flexible API for parsing and rendering markdown, similar to micromark. However, markdown-it does not provide TypeScript types out of the box, whereas micromark-util-types is specifically designed to offer type definitions for micromark.

unified

Unified is a framework for processing text with syntax trees. It provides a structured approach to parsing, transforming, and compiling various text formats, including markdown. Unified is more general-purpose compared to micromark-util-types, which is specifically tailored for micromark's type definitions.

README

micromark-util-types

micromark utility with a couple of typescript types.

Contents

• Install
• Use
• API
• Security
• Contribute
• License

Install

npm:

npm install micromark-util-types

Use

/**
 * @typedef {import('micromark-util-types').Point} Point
 */

API

This module exports no identifiers. There is no default export.

See the code for all about the exposed types.

Security

See security.md in micromark/.github for how to submit a security report.

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer