Skip to main content

Config

Less than 1 minute

Plugin Options

hostname

  • Type: string
  • Required: No

Deploy hostname.

author

  • Type: Author

    type AuthorName = string;

interface AuthorInfo {
  /**
   * Author name
   */
  name: string;

  /**
   * Author website
   */
  url?: string;

  /**
   * Author email
   */
  email?: string;
}

type Author = AuthorName | AuthorName[] | AuthorInfo | AuthorInfo[];

  • Required: No

Default author.

autoDescription

  • Type: boolean
  • Default: true

Whether generate description automatically

canonical

  • Type: string | ((page: Page) => string | null)
  • Required: No

Canonical link

fallBackImage

  • Type: string
  • Required: No

Fallback Image link when no image are found

restrictions

  • Type: string
  • Required: No

The age rating of the content, the format is [int]+, such as "13+".

twitterID

  • Type: string
  • Required: No

Fill in your twitter username.

isArticle

  • Type: (page: Page) => boolean
  • Required: No

Use this option to judge whether the page is an article.

ogp

  • Type:

    function ogp<ExtendObject = Record<string, unknown>>(
  ogp: SeoContent,
  page: ExtendPage<ExtendObject>,
  app: App
) => SeoContent;

  • Required: No

Custom OPG Generator.

You can use this options to edit OGP tags.

jsonLd

  • Type:

    function jsonLd: <ExtendObject = Record<string, unknown>>(
  jsonLD: ArticleJSONLD | null,
  page: ExtendPage<ExtendObject>,
  app: App
) => ArticleJSONLD | null;

  • Required: No

Custom JSON-LD Generator.

You can use this options to edit JSON-LD properties.

customHead

  • Type:

    function customHead<ExtendObject = Record<string, unknown>>(
  head: HeadConfig[],
  page: ExtendPage<ExtendObject>,
  app: App
) => void

  • Required: No

You can use this options to edit tags injected to <head>.

MIT Licensed | Copyright © 2019-present Mr.Hope