markdown-ast

command module
v0.0.0-...-3e27bf2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 15, 2025 License: MIT Imports: 6 Imported by: 0

README

markdown-ast

A simple command-line tool to display the Abstract Syntax Tree (AST) of Markdown documents.

This is a thin wrapper around the goldmark Markdown parser, providing easy access to its AST representation capabilities.

Installation

go install github.com/micheam/markdown-ast@latest

or if you prefer to use go run:

go run github.com/micheam/markdown-ast@latest

After installation, the markdown-ast command will be available in your $GOPATH/bin directory.

Usage

Usage: markdown-ast [options] <markdown_file>

markdown_file:
  The path to the markdown file to be processed.
  If no file is specified, stdin will be used.

Example:
  $ markdown-ast example.md
  $ markdown-ast < example.md
  $ cat example.md | markdown-ast

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL