Squidoc

プラグイン

このページでは プラグイン に焦点を当て、Squidoc プロジェクト内でどのように機能するかを説明します。

設定する内容

ここでは 検索、SEO、コードブロック、ページ、バージョン、i18n、MDX、LLM ファイルを有効化します。

公開前に確認すること

バージョン管理と i18n がルートを組み合わせる場合、順序が重要です。

関連ページ

設定 · プラグイン · デプロイ

例

npx squidoc add plugin @squidoc/plugin-search

npm install @squidoc/plugin-search

export default defineConfig({
  plugins: [
    "@squidoc/plugin-seo",
    "@squidoc/plugin-pages",
    "@squidoc/plugin-codeblocks",
    "@squidoc/plugin-article-tree",
    "@squidoc/plugin-search",
  ],
});

plugins: [
  {
    name: "@acme/squidoc-plugin-example",
    options: {
      message: "Hello from plugin options.",
    },
  },
];

plugins: ["@squidoc/plugin-seo"];

plugins: [
  {
    name: "@squidoc/plugin-codeblocks",
    options: {
      theme: "github-light",
    },
  },
];

plugins: [
  {
    name: "@squidoc/plugin-pages",
    options: {
      pagesDir: "pages",
    },
  },
];

---
export const squidoc = {
  title: "Changelog",
  description: "Product updates and release notes.",
  layout: "page",
};
---

plugins: ["@squidoc/plugin-article-tree"];

plugins: ["@squidoc/plugin-search"];

plugins: ["@squidoc/plugin-mdx"];

plugins: ["@squidoc/plugin-llms"];

plugins: [
  {
    name: "@squidoc/plugin-versions",
    options: {
      current: {
        name: "1.0",
        label: "1.0",
      },
      versions: [
        {
          name: "0.9",
          label: "0.9",
          docsPrefix: "versions/0.9",
          routePrefix: "/versions/0.9",
        },
      ],
    },
  },
];

plugins: [
  {
    name: "@squidoc/plugin-i18n",
    options: {
      defaultLocale: "en",
      locales: [
        { code: "en", label: "English" },
        { code: "es", label: "Español" },
      ],
    },
  },
];

plugins: [
  "@squidoc/plugin-seo",
  "@squidoc/plugin-pages",
  "@squidoc/plugin-codeblocks",
  "@squidoc/plugin-article-tree",
];