Skip to contents

General Metadata Tags

Source: R/general.R
meta_general.Rd

Generate metadata tags for general website properties.

Usage

meta_general(
  .meta = meta(),
  application_name = NULL,
  theme_color = NULL,
  description = NULL,
  robots = NULL,
  generator = NULL,
  subject = NULL,
  rating = NULL,
  referrer = NULL
)

meta_description(.meta = meta(), description)

meta_subject(.meta = meta(), subject)

meta_referrer(.meta = meta(), referrer)

meta_robots(.meta = meta(), robots)

meta_theme_color(.meta = meta(), theme_color)

Arguments

.meta

A meta object created by meta() or as_meta(), or returned by a meta_*() object.

application_name

Name of web application (only should be used if the website is used as an app).

theme_color

Theme Color for Chrome, Firefox OS and Opera, e.g. "#00589a".

description

Short description of the document (limit to 150 characters), This content may be used as a part of search engine results.

robots

Control the behavior of search engine crawling and indexing, e.g. "index,follow". Valid names are "index", "noindex", "follow", "nofollow". May be a vector or a single string with comma-separated values.

See https://www.robotstxt.org/meta.html for more information.

generator

Identify the software used to build the document (i.e. - WordPress, Dreamweaver).

subject

Short description of your document's subject.

rating

Gives a general age rating based on the document's content, e.g. "General".

referrer

Allows control over how referrer information is passed, .e.g. "no-referrer". Valid values include "no-referrer", "no-referrer-when-downgrade", "same-origin", "origin", "strict-origin", "origin-when-cross-origin", "strict-origin-when-cross-origin", or "unsafe-url".

Value

A meta object, or a set of <meta> HTML tags inside an HTML <head> tag. For use in rmarkdown::html_document(), shiny::runApp(), or other HTML locations.

See also

Other meta: meta_apple_itunes_app(), meta_apple_web_app(), meta_geo(), meta_google_scholar(), meta_name(), meta_social(), meta_tag(), meta_viewport(), meta()

Examples

meta() %>%
  meta_general(
    application_name = "Application Name",
    theme_color = "#4285f4",
    description = "A description of this page",
    robots = "index,follow",
    generator = "R-Shiny",
    subject = "Awesome R projects",
    rating = "General",
    referrer = "no-referrer"
  )
#> <meta name="application-name" content="Application Name"/>
#> <meta name="theme-color" content="#4285f4"/>
#> <meta name="description" content="A description of this page"/>
#> <meta name="robots" content="index,follow"/>
#> <meta name="generator" content="R-Shiny"/>
#> <meta name="subject" content="Awesome R projects"/>
#> <meta name="rating" content="General"/>
#> <meta name="referrer" content="no-referrer"/>