@textlint/markdown-to-ast

What is @textlint/markdown-to-ast?

@textlint/markdown-to-ast is an npm package that converts Markdown text into an Abstract Syntax Tree (AST). This is particularly useful for text processing, linting, and transforming Markdown content programmatically.

What are @textlint/markdown-to-ast's main functionalities?

Convert Markdown to AST

This feature allows you to convert a Markdown string into an Abstract Syntax Tree (AST). The AST can then be used for further processing, such as linting or transforming the Markdown content.

const markdownToAst = require('@textlint/markdown-to-ast');
const markdownText = '# Hello World\nThis is a sample markdown text.';
const ast = markdownToAst.parse(markdownText);
console.log(JSON.stringify(ast, null, 2));

Other packages similar to @textlint/markdown-to-ast

remark-parse

remark-parse is a Markdown parser built on top of the unified framework. It converts Markdown text into a syntax tree, similar to @textlint/markdown-to-ast. However, it is part of a larger ecosystem of plugins that can be used for various text processing tasks.

markdown-it

markdown-it is a fast and flexible Markdown parser. It converts Markdown text into HTML and can be extended with plugins. While it does not directly produce an AST, it can be used in conjunction with other tools to achieve similar functionality.

marked

marked is a low-level Markdown compiler that allows for extensive customization. It can parse Markdown into HTML and also provides an option to generate an AST, making it comparable to @textlint/markdown-to-ast.

README

@textlint/markdown-to-ast

Parse Markdown to AST with location info.

This library is not parser itself, it dependent on wooorm/remark.

Markdown -> remark -> markdown-to-ast -> TxtNodes

The AST consists of TxtNodes. A TxtNode of the AST has following properties:

• loc - Nodes have line and column-based location info.
• range - Nodes have an index-based location range (array).
• raw - Node have a raw text.
• value - Node have a value of text.

The interface are defined in textlint/txtnode.md

This library is a part of textlint/textlint.

If you need to markdown parser, please use wooorm/remark directly.

DEMO

• textlint AST explorer

Installation

npm install @textlint/markdown-to-ast

Usage

var parse = require("@textlint/markdown-to-ast").parse;
var markdown = "It's a *text*";
var AST = parse(markdown);
/*
{
    "type": "Document",
    "children": [
        {
            "type": "Paragraph",
            "children": [
                {
                    "type": "Str",
                    "value": "It's a ",
                    "loc": {
                        "start": {
                            "line": 1,
                            "column": 0
                        },
                        "end": {
                            "line": 1,
                            "column": 7
                        }
                    },
                    "range": [
                        0,
                        7
                    ],
                    "raw": "It's a "
                },
                {
                    "type": "Emphasis",
                    "children": [
                        {
                            "type": "Str",
                            "value": "text",
                            "loc": {
                                "start": {
                                    "line": 1,
                                    "column": 8
                                },
                                "end": {
                                    "line": 1,
                                    "column": 12
                                }
                            },
                            "range": [
                                8,
                                12
                            ],
                            "raw": "text"
                        }
                    ],
                    "loc": {
                        "start": {
                            "line": 1,
                            "column": 7
                        },
                        "end": {
                            "line": 1,
                            "column": 13
                        }
                    },
                    "range": [
                        7,
                        13
                    ],
                    "raw": "*text*"
                }
            ],
            "loc": {
                "start": {
                    "line": 1,
                    "column": 0
                },
                "end": {
                    "line": 1,
                    "column": 13
                }
            },
            "range": [
                0,
                13
            ],
            "raw": "It's a *text*"
        }
    ],
    "loc": {
        "start": {
            "line": 1,
            "column": 0
        },
        "end": {
            "line": 1,
            "column": 13
        }
    },
    "range": [
        0,
        13
    ],
    "raw": "It's a *text*"
}
*/

If you want to know real use-case, please see textlint/textlint.

Tests

npm test

Create fixtures

See tools/ directory.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

License

MIT