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

WebSite Schema

Schema.org WebSite

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

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>
}
Did this page help you?