Squidoc

主题

本页聚焦 主题,说明它在 Squidoc 项目中的工作方式。

你将配置什么

你将学习如何替换布局、导航、页脚、插槽和视觉选项。

发布前检查

主题应支持稳定的 docspage 布局。

相关阅读

配置 · 插件 · 部署

示例

export default defineConfig({
  theme: "@squidoc/theme-basic",
});
export default defineConfig({
  theme: {
    name: "@squidoc/theme-basic",
    options: {
      headerLinks: [{ title: "GitHub", href: "https://github.com/Squidoc/Squidoc" }],
      footer: {
        text: "Built with Squidoc.",
        links: [
          { title: "GitHub", href: "https://github.com/Squidoc/Squidoc" },
          { title: "Configuration", path: "/docs/configuration" },
        ],
      },
    },
  },
});
npx squidoc add theme @acme/squidoc-theme
npm install @acme/squidoc-theme
export default defineConfig({
  theme: "@acme/squidoc-theme",
});
primaryColor: "#4a54df";
headerLinks: [
  { title: "GitHub", href: "https://github.com/Squidoc/Squidoc" },
  { title: "Deployment", path: "/docs/deployment" },
];
footer: {
  text: "Built with Squidoc.",
  links: [
    { title: "GitHub", href: "https://github.com/Squidoc/Squidoc" },
    { title: "Plugins", path: "/docs/plugins" },
  ],
};