Skip to content

pebrianz/markdown-ast

Repository files navigation

📚 markdown-ast

Markdown AST library — high-performance markdown parser for JavaScript/TypeScript.


✨ Features

  • AssemblyScript Core — Fast & WebAssembly-compatible parsing.
  • 📝 Basic Markdown Support — Covers common formatting needs (see list below).

✅ Supported Markdown Syntax

Category Syntax Example
Headings #, ##, ### … up to ###### ## Heading 2
Bold / Italic **bold**, *italic* bold, italic
Blockquotes > quote > This is a quote
Lists - item / 1. item - Unordered
1. Ordered

see more.


🛣 Roadmap (Upcoming)

  • 🌐 AST → HTML Transformation
  • 🎨 Syntax Highlighting for fenced code blocks
  • 🔢 LaTeX Support inside Markdown content

📦 Installation

npm install @markdown-ast/parser

🚀 Usage Example

import { parse } from '@markdown-ast/parser';

const markdown = `
# Welcome

This is **bold**, *italic*, a [link](https://example.com), and some \`inline code\`.

\`\`\`ts
console.log("Hello, AST!");
\`\`\`
`;

const ast = parse(markdown);
console.dir(ast, { depth:null });

📂 Project Structure

markdown-ast/
├── packages/
│   └── parser/            # Core AssemblyScript Markdown parser
│   ├── transformer/         # (Planned) AST → HTML transformer
└── package.json           # Monorepo workspaces configuration

🤝 Contributing

  1. Fork the repo

  2. Create your branch:

    git checkout -b feature/amazing-feature
  3. Commit your changes:

    git commit -m "Add amazing feature"
  4. Push and open a Pull Request


📜 License

Licensed under the MIT License — see LICENSE for details.


💬 Support

About

high-performance markdown parser for javascript/typescript.

Resources

License

Stars

Watchers

Forks

Releases

No releases published