Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitboxer/opengraph_parser

Elixir library for parsing OpenGraph data (http://ogp.me)
https://github.com/bitboxer/opengraph_parser

elixir opengraph

Last synced: 2 months ago
JSON representation

Elixir library for parsing OpenGraph data (http://ogp.me)

Awesome Lists containing this project

README

        

# OpenGraph

[![Build Status](https://github.com/bitboxer/opengraph_parser/actions/workflows/elixir.yml/badge.svg?branch=main)](https://github.com/bitboxer/opengraph_parser/actions/workflows/elixir.yml)
[![Hex.pm version](https://img.shields.io/hexpm/v/opengraph_parser.svg)](https://hex.pm/packages/opengraph_parser)
[![Hex.pm downloads](https://img.shields.io/hexpm/dt/opengraph_parser.svg)](https://hex.pm/packages/opengraph_parser)

A Elixir wrapper for the [Open Graph protocol](http://ogp.me). This is a fork of
[open_graph_extended](https://framagit.org/tcit/open_graph). The main goal is to
have an active maintained version again.

## Installation

The package can be installed by `opengraph_parser` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[{:opengraph_parser, "~> 0.6.0"}]
end
```

## Usage

```elixir
iex(2)> OpenGraph.parse("

Some title

")

%OpenGraph{description: nil, image: nil, site_name: nil, title: "Some title",
type: nil, url: nil}
```

## License

OpenGraphParser Elixir source code is licensed under the MIT License.