Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hlongvu/phoenix_meta_tags
Phoenix library helps generating meta tags for website.
https://github.com/hlongvu/phoenix_meta_tags
elixir meta metatags opengrah phoenix tags
Last synced: about 1 month ago
JSON representation
Phoenix library helps generating meta tags for website.
- Host: GitHub
- URL: https://github.com/hlongvu/phoenix_meta_tags
- Owner: hlongvu
- License: mit
- Created: 2018-11-19T02:01:23.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-01T21:30:13.000Z (10 months ago)
- Last Synced: 2024-10-07T04:28:18.028Z (2 months ago)
- Topics: elixir, meta, metatags, opengrah, phoenix, tags
- Language: Elixir
- Size: 42 KB
- Stars: 30
- Watchers: 4
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Generate meta tags for a website. (Framework Components)
- fucking-awesome-elixir - phoenix_meta_tags - Generate meta tags for a website. (Framework Components)
- awesome-elixir - phoenix_meta_tags - Generate meta tags for a website. (Framework Components)
README
## Phoenix Meta Tags
[](https://hex.pm/packages/phoenix_meta_tags)
[](https://hexdocs.pm/phoenix_meta_tags/)
[](https://hex.pm/packages/phoenix_meta_tags)
[](https://github.com/hlongvu/phoenix_meta_tags/blob/master/LICENSE.md)
[](https://github.com/hlongvu/phoenix_meta_tags/commits/master)
This is a library helps generate meta tags for a website.
### Default Usage
From a struct like this:
```elixir
%{
title: "Phoenix Title",
description: "Phoenix Descriptions",
url: "https://phoenix.meta.tags",
image: "https://phoenix.meta.tags/logo.png"
}
```
will become:
```html
# Default tags
Phoenix Title
#Open Graph tags
#Twitter tags
```
### Advanced Usage
Other key value of tags map will be rendered individually by key. Nested map will be rendered by *flat-representation* of keys. For example:
```elixir
map = %{
title: "Phoenix Title",
description: "Phoenix Descriptions",
url: "https://phoenix.meta.tags",
image: "https://phoenix.meta.tags/logo.png",
fb: %{
name: "facebook",
size: %{
width: 100,
height: 200,
position: %{
x: 10,
y: 15
}
}
}
}
```
In addition to default tags like above example, the rendered tags will have more:
```html
```
Instead of a nested map, you can also use a string-key map, this also delivers the same result:
```elixir
map = %{
"title" => "PhoenixTags",
"fb:name" => "facebook",
"fb:size:width" => 100,
"fb:size:height" => 200,
"fb:size:position:x" => 10,
"fb:size:position:y" => 15
}
```
### Tag Value Override
In default rendering, the **og:title** tag will get value from **title**. If you re-define **og:title** value, the new value will be override the default **title** value. For example:
```elixir
map = %{
title: "Phoenix Title",
og: %{
title: "Override"
}
}
```
Will have output:
```html
Phoenix Title
```
## Installation
The package can be installed by adding `:phoenix_meta_tags` to your list of
dependencies in `mix.exs`:
```elixir
def deps do
[
{:phoenix_meta_tags, ">= 0.1.9"}
]
end
```
In your Web Module add this:
```elixir
def view do
quote do
...
use PhoenixMetaTags.TagView # Add this
end
end
def controller do
quote do
...
use PhoenixMetaTags.TagController # Add this
end
end
```
Also put this render function inside your **\** tag of `app.html.eex`:
```elixir
<%= render_tags_all(assigns[:meta_tags] || %{})%> # Add this
```
## Usage
Wherever you want to render meta tags, jut put it before render your view:
```elixir
conn
|> put_meta_tags(%{
title: "Phoenix Title",
description: "Phoenix Descriptions",
url: "https://phoenix.meta.tags",
image: "https://phoenix.meta.tags/logo.png"
})
|>render("index.html")
```
Or, use it as a plug:
```elixir
@meta %{
title: "Phoenix Title",
description: "Phoenix Descriptions",
url: "https://phoenix.meta.tags",
image: "https://phoenix.meta.tags/logo.png"
}
plug :put_meta_tags, @meta
```
### Default value
You can put the default value for meta tags in your config file. This config will be merge with runtime tags before rendering.
```elixir
config :phoenix_meta_tags,
title: "Phoenix Title Default",
description: "Phoenix Descriptions Default",
url: "https://phoenix.meta.tags.default",
image: "https://phoenix.meta.tags.default/logo.png",
"og:text": "Hello Open Graph",
fb: %{
name: "facebook",
size: %{
width: 100,
height: 200,
position: %{
x: 10,
y: 15
}
}
}
```
## Copyright and License
Copyright (c) 2018 hlongvu
This work is free. You can redistribute it and/or modify it under the
terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.