Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhinav/goldmark-hashtag
Adds support for #hashtags to the Goldmark Markdown parser.
https://github.com/abhinav/goldmark-hashtag
golang markdown
Last synced: 2 months ago
JSON representation
Adds support for #hashtags to the Goldmark Markdown parser.
- Host: GitHub
- URL: https://github.com/abhinav/goldmark-hashtag
- Owner: abhinav
- License: bsd-3-clause
- Created: 2021-04-20T13:57:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T00:25:30.000Z (3 months ago)
- Last Synced: 2024-10-24T11:18:54.591Z (3 months ago)
- Topics: golang, markdown
- Language: Go
- Homepage: https://abhinav.github.io/goldmark-hashtag/
- Size: 92.8 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# goldmark-hashtag
[](https://pkg.go.dev/go.abhg.dev/goldmark/hashtag)
[](https://github.com/abhinav/goldmark-hashtag/actions/workflows/go.yml)
[](https://codecov.io/gh/abhinav/goldmark-hashtag)
goldmark-hashtag is an extension for the [goldmark] Markdown parser
that adds support for tagging documents with `#hashtag`s.
[goldmark]: http://github.com/yuin/goldmark
**Demo**:
A web-based demonstration of the extension is available at
.
## Installation
```bash
go get go.abhg.dev/goldmark/hashtag@latest
```
## Usage
To use goldmark-hashtag, import the `hashtag` package.
```go
import "go.abhg.dev/goldmark/hashtag"
```
Then include the `hashtag.Extender` in the list of extensions you build your
[`goldmark.Markdown`] with.
[`goldmark.Markdown`]: https://pkg.go.dev/github.com/yuin/goldmark#Markdown
```go
goldmark.New(
goldmark.WithExtensions(
&hashtag.Extender{},
),
// ...
).Convert(src, out)
```
This alone has little effect
besides adding `...`
around hashtags in your Markdown document.
You must supply a `hashtag.Resolver` to render hashtags as links.
## Link resolution
Supply a [`hashtag.Resolver`] to the `hashtag.Extender`
to render hashtags as links:
[`hashtag.Resolver`]: https://pkg.go.dev/go.abhg.dev/goldmark/hashtag#Resolver
```go
goldmark.New(
goldmark.WithExtensions(
&hashtag.Extender{
Resolver: hashtagResolver,
},
),
// ...
).Convert(src, out)
```
## Syntax
Hashtags must always begin with a "#".
The characters that follow that depend on the variant you have chosen.
goldmark-hashtag supports the following variants:
- *Default*: Hashtags must begin with a letter, and may contain letters,
numbers and any of the following symbols: `/_-`.
goldmark-hashtag uses this variant if you do not specify one.
- *Obsidian*: Hashtags can begin with and contain letters, numbers, emoji, and
any of the following symbols: `/_-`, but must not contain only numbers.
You can specify the variant by setting the `Variant` property of the
`hashtag.Extender`.
```go
&hashtag.Extender{
// ...
Variant: hashtag.ObsidianVariant,
}
```
## Inspection
To collect all hashtags from a Markdown document, use Goldmark's [`ast.Walk`]
function after parsing the document.
[`ast.Walk`]: https://pkg.go.dev/github.com/yuin/goldmark/ast#Walk
For example, the following will populate the `hashtags` map with all hashtags
found in the document.
```go
markdown := goldmark.New(
goldmark.WithExtensions(
&hashtag.Extender{
Resolver: hashtagResolver,
},
),
// ...
)
// Parse the Markdown document.
doc := markdown.Parser().Parse(text.NewReader(src))
// List the tags.
hashtags := make(map[string]struct{})
ast.Walk(doc, func(node ast.Node, enter bool) (ast.WalkStatus, error) {
if n, ok := node.(*hashtag.Node); ok && enter {
hashtags[string(n.Tag)] = struct{}{}
}
return ast.WalkContinue, nil
})
```