首页
/ Metamagic 项目技术文档

Metamagic 项目技术文档

2024-12-18 23:49:59作者：咎竹峻Karen
metamagic
Simple Ruby on Rails plugin for creating meta tags.
项目地址：https://gitcode.com/gh_mirrors/me/metamagic

1. 安装指南

首先，确保您的项目环境中安装有 Ruby 1.9 或以上版本以及 Rails 3.0 或以上版本。在您的项目 Gemfile 文件中添加以下依赖：

gem 'metamagic'

然后执行 bundle install 命令以安装 Metamagic gem。

2. 项目的使用说明

Metamagic 是一个用于创建 meta 标签的 Ruby on Rails 插件，支持常规 meta 标签、OpenGraph（Facebook）、Twitter Cards 以及自定义标签。

基本用法

在您的视图文件顶部，如 app/views/posts/show.html.erb：

<%
meta title: "我的标题",
     description: "我的描述",
     keywords: %w(关键词1 关键词2 关键词3)
%>

然后在布局文件 app/views/layouts/application.html.erb 中：

<head>
  <%= metamagic %>
  ...
</head>

这会生成以下 meta 标签：

<head>
  <title>我的标题</title>
  <meta content="我的描述" name="description" />
  <meta content="关键词1, 关键词2, 关键词3" name="keywords" />
  ...
</head>

使用模板

模板可用于在布局中插入视图中设置的 meta 值。例如，如果您想在所有页面的标题中添加内容，或为所有页面添加默认关键词，可以使用模板。模板支持所有标签类型，包括 OpenGraph、Twitter 等。

标题模板

在模板中：

<%
meta title: "我的标题"
%>

在布局中：

<%
metamagic site: "我的站点", title: [:title, :site], separator: " — "
%>

这将渲染以下内容：

<head>
  <title>我的标题 — 我的站点</title>
  ...
</head>

默认分隔符是 -。

如果视图中未设置标题，它将只显示站点名称。

关键词模板

关键词模板可用于为站点的所有页面添加默认关键词。

在模板中：

<%
meta keywords: %{一个 两个 三}
%>

在布局中：

<%
metamagic keywords: [:keywords, "四个", "五个", "六个"]
%>

这将生成以下内容：

<head>
  <meta content="一个, 两个, 三, 四个, 五个, 六个" name="keywords" />
  ...
</head>

为其他标签类型添加模板

模板支持所有标签类型。可以通过将视图中的冒号（:）替换为下划线（_）来访问 meta 键的值，例如 og:image 可以通过 og_image 访问。

快捷助手

为了方便设置 meta 标签，您可以使用快捷助手：

<%
title "我的标题"
description "我的描述"
keywords %w(关键词1 关键词2 关键词3)
%>

这会生成以下内容：

<head>
  <title>我的标题</title>
  <meta content="我的描述" name="description" />
  <meta content="关键词1, 关键词2, 关键词3" name="keywords" />
  ...
</head>

快捷助手返回您发送给它们的值，因此可以通过在 <h1> 标签中设置标题来减少代码冗余：

<h1><%= title "我的标题" %></h1>

这与在视图顶部设置标题相同。

注意： 快捷助手不会覆盖视图中已经存在的方法，例如如果已经有一个名为 title 的方法，它不会被覆盖。

指定默认 meta 标签值

可以在布局中指定默认值，如果视图没有指定自己的值，将显示这些默认值：

<head>
  <%= metamagic title: "我的默认标题", description: "我的默认描述。", keywords: %w(关键词1 关键词2 关键词3) %>
  ...
</head>

3. 项目API使用文档

Metamagic 提供了多种方法来定义 meta 标签，包括自定义标签和属性。

自定义 meta 标签

<%
meta my_custom_name: "我的自定义值"
%>

这将生成以下内容：

<head>
  ...
  <meta content="我的自定义值" name="my_custom_name" />
  ...
</head>

添加关系链接

<%
meta rel: {
  author: "http://test.com/author.html",
  publisher: "http://test.com/publisher.html"
}
%>

或者使用 rel 快捷助手：

<%
rel author: "http://test.com/author.html",
    publisher: "http://test.com/publisher.html"
%>

自定义属性

OpenGraph（Facebook）

<%
meta og: {
  image: "http://mydomain.com/images/my_image.jpg"
}
%>

Twitter Cards

<%
meta twitter: {
  card: "summary",
  site: "@flickr"
}
%>

其他自定义属性

<%
meta property: {
  one: "属性一",
  two: "属性二",
  nested: {
    a: "嵌套A",
    b: "嵌套B"
  }
}
%>

自定义标签

可以为指定的标签前缀添加自定义渲染：

在 config/initializers/metamagic.rb：

Metamagic::Renderer.register_tag_type :custom, ->(key, value) { tag(:custom_tag, first: key, second: value) }

在视图中：

<%
meta title: "我的标题",
     custom: {
       key_one: "我的第一个键",
       key_two: "我的第二个键"
     }
%>

这将渲染以下内容：

<title>我的标题</title>
<custom_tag first="custom:key_one" second="我的第一个键" />
<custom_tag first="custom:key_two" second="我的第二个键" />

当注册一个新的标签类型时，会自动定义一个快捷助手。因此，上面的代码也可以写成：

<%
custom key_one: "我的第一个键",
       key_two: "我的第二个键"
%>

4. 项目安装方式

Metamagic 可以通过添加到 Gemfile 并运行 bundle install 来安装。确保您使用的是 Ruby 1.9 或更高版本以及 Rails 3.0 或更高版本。在 Gemfile 中添加以下代码：

gem 'metamagic'

然后执行以下命令：

bundle install
metamagic
Simple Ruby on Rails plugin for creating meta tags.
项目地址：https://gitcode.com/gh_mirrors/me/metamagic

相关内容推荐

1 探索Speedrail：打造高效SaaS应用的火箭发射台2 `_` 项目技术文档3 Hyde项目技术文档4 Soloist 项目技术文档5 get_iplayer 项目技术文档6 OCHamcrest 项目技术文档7 Ve 项目技术文档8 pqR 项目技术文档9 ShowMe 项目技术文档10 Samurai 项目技术文档
热门项目推荐
相关项目推荐

热门内容推荐

1 开源项目 developer-roadmap 使用教程2 开发者路线图项目教程3 开源项目 `awesome-selfhosted` 使用教程4 Vue.js 教程与指南5 探索Vue 2的持久魅力：一个开源项目的深度解析6 Linux 内核项目使用教程7 开源项目指南：Linux 内核8 推荐项目：探索 Linux 内核的奥秘9 Linux内核项目技术文档10 TensorFlow 开源项目教程

最新内容推荐

《深入掌握OpenPTrack：安装与实战指南》 《RBM-MNIST深度学习算法安装与实战指南》 《Boundingmesh项目实战指南：安装、配置与深度探索》 探索三维世界：cpu_tsdf开源项目的安装与使用教程 探索Embxx：嵌入式C++库的安装与使用指南 深入解析Valijson：安装、使用与实践指南 《稳健点集配准算法GMMReg的安装与使用教程》 《luacppinterface：C++与Lua混合编程的桥梁》 深入掌握makerscanner：安装与使用指南 《SoftModem：开源的Arduino与手机通信解决方案》

项目优选

收起
MateChatMateChat
前端智能化场景解决方案UI库，轻松构建你的AI应用，我们将持续完善更新，欢迎你的使用与建议。 官网地址：https://matechat.gitcode.com
383
36
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
611
115
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码，欢迎大家投稿，让全世界看到您的妙趣设计，也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
58
Ffit-framework
FIT: 企业级AI开发框架，提供多语言函数引擎（FIT）、流式编排引擎（WaterFlow）及Java生态的LangChain替代方案（FEL）。原生/Spring双模运行，支持插件热插拔与智能聚散部署，无缝统一大模型与业务系统。
Java
113
13
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
29
cjoycjoy
a fast，lightweight and joy web framework
Cangjie
11
2
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！
Cangjie
286
79
hertzhertz
Go 微服务 HTTP 框架，具有高易用性、高性能、高扩展性等特点。
Go
7
1
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件，通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求，让密码技术应用更简单，同时探索后量子等先进算法创新实践，构建密码前沿技术底座！
C
60
48
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件，采用集群高扩展架构，通过应用备份通用框架、并行备份等技术，为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力，帮助用户实现关键数据高效保护。
HTML
90
65