Index of every page on this site: llms.txt
Unhead
TypeScript
Schema

WebSite Schema Markup: JSON-LD Example and API

Copy for LLMs
On this page

WebSite structured data names your site and connects it to its publisher and pages. Google reads WebSite markup on the home page to choose the site name that it shows in search results.

JSON-LD Example

Unhead renders this JSON-LD for the example. It sets url to the canonical host and inLanguage from page metadata.

{
  "@context": "https://schema.org",
  "@graph": [
    {
      "@id": "https://example.com/#website",
      "@type": "WebSite",
      "inLanguage": "en-AU",
      "name": "My Site",
      "url": "https://example.com/"
    }
  ]
}

Schema.org WebSite

  • Type: defineWebSite<T extends Record<string, any>>(input?: WebSite & T)
    Describes a website and its relationship to its WebPage nodes.

Useful Links

Required properties

  • name string
    The name of the website. Supply it directly; the WebSite resolver does not inherit the page title.

Defaults

  • @type: WebSite
  • @id: ${canonicalHost}#website
  • url: canonicalHost
  • inLanguage: inLanguage from resolved page metadata (see: Schema.org Params)
  • publisher: Identity reference

Example

defineWebSite({
  name: 'My Site',
})

Types

/**
 * A WebSite is a set of related web pages and other items typically served from a single web domain and accessible via URLs.
 */
export interface WebSiteSimple extends Thing {
  /**
   * The site's home URL (excluding a trailing slash).
   */
  url?: string
  /**
   * The name of the website.
   */
  name: string
  /**
   * A description of the website (e.g., the site's tagline).
   */
  description?: string
  /**
   * The date the website was first published.
   */
  datePublished?: ResolvableDate
  /**
   * The date the website was last modified.
   */
  dateModified?: ResolvableDate
  /**
   * A reference-by-ID to the Organization which publishes the WebSite
   * (or an array of Organization and Person in the case that the website represents an individual).
   */
  publisher?: NodeRelations<Identity>
  /**
   * A SearchAction object describing the site's internal search.
   */
  potentialAction?: Arrayable<(SearchAction | unknown)>
  /**
   * The language code for the WebSite; e.g., en-GB.
   * If the website is available in multiple languages, then output an array of inLanguage values.
   */
  inLanguage?: Arrayable<string>
}
Edit this page
Markdown For LLMs
Did this page help you?

WebPage Schema

Use defineWebPage() to add WebPage structured data. Connect page content to your site hierarchy with automatic page type detection.