Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willnorris/microformats
Go library for parsing microformats
https://github.com/willnorris/microformats
microformats
Last synced: 18 days ago
JSON representation
Go library for parsing microformats
- Host: GitHub
- URL: https://github.com/willnorris/microformats
- Owner: willnorris
- License: mit
- Created: 2016-05-07T01:00:13.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T06:41:25.000Z (9 months ago)
- Last Synced: 2024-10-14T15:44:20.842Z (about 1 month ago)
- Topics: microformats
- Language: Go
- Homepage: https://pkg.go.dev/willnorris.com/go/microformats
- Size: 208 KB
- Stars: 63
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# microformats
[](https://pkg.go.dev/willnorris.com/go/microformats)
[](https://github.com/willnorris/microformats/actions?query=workflow%3Aci)
[](https://codecov.io/gh/willnorris/microformats)
microformats is a go library and tool for parsing [microformats][], supporting both classic v1 and [v2 syntax][].
It is based on Andy Leap's [original library][andyleap/microformats].
[microformats]: https://microformats.io/
[v2 syntax]: https://microformats.org/wiki/microformats-2
[andyleap/microformats]: https://github.com/andyleap/microformats
## Usage
To see this package in action, the simplest way is to install the command line
app and use it to fetch and parse a webpage with microformats on it:
```sh
% go install willnorris.com/go/microformats/cmd/gomf@latest
% gomf https://indieweb.org
```
To use it in your own code, import the package:
```go
import "willnorris.com/go/microformats"
```
If you have the HTML contents of a page in an [io.Reader][], call [Parse][] like in this example:
```go
content := `
Hello
`
r := strings.NewReader(content)
data := microformats.Parse(r, nil)
// do something with data, or just print it out as JSON:
enc := json.NewEncoder(os.Stdout)
enc.SetIndent("", " ")
enc.Encode(data)
```
Alternately, if you have already parsed the page and have an [html.Node][], then call [ParseNode][].
For example, you might want to select a subset of the DOM, and parse only that for microformats.
An example of doing this with the [goquery package] can be seen in [cmd/gomf/main.go](cmd/gomf/main.go).
To see that in action using the gomf app installed above,
you can parse the microformats from indieweb.org that appear within the `#content` element:
```sh
% gomf https://indieweb.org "#content"
{
"items": [
{
"id": "content",
"type": [
"h-entry"
],
"properties": ...
"children": ...
}
],
"rels": {},
"rel-urls": {}
}
```
[Parse]: https://pkg.go.dev/willnorris.com/go/microformats#Parse
[ParseNode]: https://pkg.go.dev/willnorris.com/go/microformats#ParseNode
[io.Reader]: https://golang.org/pkg/io/#Reader
[html.Node]: https://pkg.go.dev/golang.org/x/net/html#Node
[goquery package]: https://github.com/PuerkitoBio/goquery
## Additional helper packages
Use the [ptd package] to perform [Post Type Discovery].
Use the [rhc package] to find a [Representative h-card].
[ptd package]: https://pkg.go.dev/willnorris.com/go/microformats/ptd
[Post Type Discovery]: https://www.w3.org/TR/post-type-discovery/
[rhc package]: https://pkg.go.dev/willnorris.com/go/microformats/rhc
[Representative h-card]: http://microformats.org/wiki/representative-hcard