nikitavoloboev / markdown-parser

Go library to parse markdown to grab various things

Markdown Parser

Go library to parse markdown to grab various things

This library will parse a given markdown file and grab all links from it and put it into a hashmap map[string]string to use.

Install

go get -u github.com/nikitavoloboev/markdown-parser

Usage

See Docs.

You can see this library being used in Alfred Awesome Lists to grab all links from Sindre's awesome lists and filter the results in Alfred.

Contribute

Always open to useful ideas or fixes in form of issues or PRs.

Can open new issue (search existing issues first) or start discussion.

It's okay to submit draft PR as you can get help along the way to make it merge ready.

Join Discord for more indepth discussions on this repo and others.

🖤

Support on GitHub or look into other projects.

markdown-parser's Issues

Parse a line with a link and a description

Can use this regex.

Or maybe use this: https://github.com/alecthomas/participle

Useful:

• https://github.com/yoshuawuyts/playground-markdown

add md-to-alfred to library

Testing Locally

How exactly should I test to see if my edited code works? I see that you have a parser_test.go file, but I can't seem to test it without getting an error (go test parser_test.go):

# command-line-arguments [command-line-arguments.test]
./parser_test.go:9:6: missing function body
./parser_test.go:10:6: missing function body
./parser_test.go:11:6: missing function body
./parser_test.go:15:2: undefined: ParseLinkWithDescription
./parser_test.go:20:17: undefined: ParseMarkdownFile
FAIL	command-line-arguments [build failed]

Note that I do have my fork cloned into ~/go/src/johnletey/markdown-parser

Add support for parsing image links

Image embedding in markdown works like:

![](https://i.imgur.com/ZVPjkzh.png)

The API should given a line recognize if it's an embedded image and if it is should extract the link inside it [<link>].

write parser

For Gitbook, save the entire path to the file

Can be used in Alfred for subtitles

Please add a license

Bug 🐞

Docs (https://pkg.go.dev/github.com/nikitavoloboev/markdown-parser) is not opening as the repo doesn't have a license.
Please add a license, to make doc available, and more importantly, to let people use it without any concern.

Steps to Reproduce:

figure out how to get markdown from URL on GitHub

Add ability to specify the range where the parser works

So I can pick a heading with a name and parse links only from that heading and nothing else.

Grab first subdash description and save it in Gitbook parse

For use in Alfred.

check for heading

add testing

check for badges

Add a changelog