feat(plugin-seo): add seo plugin (#42)

vuepress · Jan 31, 2024 · 8a999c5 · 8a999c5
1 parent b0b2aa4
commit 8a999c5
Show file tree

Hide file tree

Showing 55 changed files with 2,788 additions and 3 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -28,6 +28,7 @@
     "frontmatter",
     "globby",
     "gtag",
+    "jsonld",
     "mdit",
     "nord",
     "nprogress",

diff --git a/docs/.vuepress/configs/navbar/en.ts b/docs/.vuepress/configs/navbar/en.ts
@@ -39,7 +39,7 @@ export const navbarEn: NavbarConfig = [
       },
       {
         text: 'SEO',
-        children: ['/plugins/sitemap'],
+        children: ['/plugins/seo/', '/plugins/sitemap/'],
       },
       {
         text: 'Syntax Highlighting',

diff --git a/docs/.vuepress/configs/navbar/zh.ts b/docs/.vuepress/configs/navbar/zh.ts
@@ -39,7 +39,7 @@ export const navbarZh: NavbarConfig = [
       },
       {
         text: '搜索引擎增强',
-        children: ['/zh/plugins/sitemap'],
+        children: ['/zh/plugins/seo/', '/zh/plugins/sitemap/'],
       },
       {
         text: '语法高亮',

diff --git a/docs/.vuepress/configs/sidebar/en.ts b/docs/.vuepress/configs/sidebar/en.ts
@@ -41,6 +41,11 @@ export const sidebarEn: SidebarConfig = {
     {
       text: 'SEO',
       children: [
+        {
+          text: 'SEO',
+          link: '/plugins/seo/',
+          children: ['/plugins/seo/guide', '/plugins/seo/config'],
+        },
         {
           text: 'Sitemap',
           link: '/plugins/sitemap/',

diff --git a/docs/.vuepress/configs/sidebar/zh.ts b/docs/.vuepress/configs/sidebar/zh.ts
@@ -41,6 +41,11 @@ export const sidebarZh: SidebarConfig = {
     {
       text: '搜索引擎增强',
       children: [
+        {
+          text: '搜索引擎增强',
+          link: '/zh/plugins/seo/',
+          children: ['/zh/plugins/seo/guide', '/zh/plugins/seo/config'],
+        },
         {
           text: '站点地图',
           link: '/zh/plugins/sitemap/',

diff --git a/docs/plugins/seo/README.md b/docs/plugins/seo/README.md
@@ -0,0 +1,21 @@
+# seo
+
+<NpmBadge package="@vuepress/plugin-seo" />
+
+## Usage
+
+```bash
+npm i -D @vuepress/plugin-seo@next
+```
+
+```ts title=".vuepress/config.ts"
+import { seoPlugin } from "@vuepress/plugin-seo";
+
+export default {
+  plugins: [
+    seoPlugin({
+      // options
+    }),
+  ],
+}
+```
diff --git a/docs/plugins/seo/config.md b/docs/plugins/seo/config.md
@@ -0,0 +1,151 @@
+# Config
+
+## hostname
+
+- Type: `string`
+- Required: Yes
+- Details:
+
+  Deploy hostname.
+
+## author
+
+- Type: `Author`
+
+  ```ts
+  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
+
+- Details:
+
+  Default author.
+
+## autoDescription
+
+- Type: `boolean`
+- Default: `true`
+- Details:
+
+  Whether generate description automatically
+
+## canonical
+
+- Type: `string | ((page: Page) => string | null)`
+- Details:
+
+  Canonical link
+
+## fallBackImage
+
+- Type: `string`
+- Details:
+
+  Fallback Image link when no image are found
+
+## restrictions
+
+- Type: `string`
+- Details:
+
+  The age rating of the content, the format is `[int]+`, such as `"13+"`.
+
+## twitterID
+
+- Type: `string`
+- Details:
+
+  Fill in your twitter username.
+
+## isArticle
+
+- Type: `(page: Page) => boolean`
+- Details:
+
+  Use this option to judge whether the page is an article.
+
+## ogp
+
+- Type:
+
+  ```ts
+  function ogp(
+    /** OGP info inferred by plugin */
+    ogp: SeoContent,
+    /** Page Object */
+    page: Page,
+    /** VuePress App */
+    app: App,
+  ): SeoContent;
+  ```
+
+- Required: No
+- Details:
+
+  Custom OPG Generator.
+
+  You can use this options to edit OGP tags.
+
+## jsonLd
+
+- Type:
+
+  ```ts
+  function jsonLd(
+    /** JSON-LD Object inferred by plugin */
+    jsonLD: ArticleSchema | BlogPostingSchema | WebPageSchema,
+    /** Page Object */
+    page: Page,
+    /** VuePress App */
+    app: App,
+  ): ArticleSchema | BlogPostingSchema | WebPageSchema;
+  ```
+
+- Required: No
+
+- Details:
+
+  Custom JSON-LD Generator.
+
+  You can use this options to edit JSON-LD properties.
+
+## customHead
+
+- Type:
+
+  ```ts
+  function customHead(
+    /** Head tag config */
+    head: HeadConfig[],
+    /** Page Object */
+    page: Page,
+    /** VuePress App */
+    app: App,
+  ): void;
+  ```
+
+- Required: No
+
+- Details:
+
+  You can use this options to edit tags injected to `<head>`.