Squidoc

ページ

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

設定する内容

ここでは ホームページ、変更履歴、製品ページを docs ツリー外に作ります。

公開前に確認すること

対応レイアウトは page と docs のみで、動的ルートはまだ対象外です。

関連ページ

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

例

docs/
  index.md
  configuration.md
pages/
  index.astro
  changelog.astro

/docs/
/docs/configuration/
/
/changelog/

npm install @squidoc/plugin-pages

import { defineConfig } from "squidoc";

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

---
export const squidoc = {
  title: "My Docs",
  description: "A custom homepage for my docs site.",
};
---

<section>
  <h1>My Docs</h1>
  <p>Read the latest documentation.</p>
  <a href="/docs/getting-started">Get started</a>
</section>

export default defineConfig({
  plugins: [
    {
      name: "@squidoc/plugin-pages",
      options: {
        pagesDir: "custom-pages",
      },
    },
  ],
});

---
export const squidoc = {
  title: "Changelog",
  layout: "docs",
};
---

<h1>Changelog</h1>