国际化
Squidoc 是一个静态优先的文档平台,内置插件系统、主题系统和面向 SEO 的默认配置。你可以编写 Markdown,通过 docs.config.ts 配置项目,并发布快速的静态站点。
项目结构
文档文章放在 docs/,可选 Astro 页面放在 pages/,docs.config.ts 连接站点元数据、导航、插件和主题。
扩展
插件可以添加搜索、SEO、代码块、版本管理、国际化和生成文件。主题控制布局、导航和插件插槽。
验证
部署前运行 npm run check、npm run build 和 npm run preview。
i18n
此页面与英文文档保持对应,确保所有支持的语言在当前版本中拥有相同的文档覆盖范围。
参考示例
plugins: [
{
name: "@squidoc/plugin-i18n",
options: {
defaultLocale: "en",
locales: [
{ code: "en", label: "English" },
{ code: "es", label: "Español" },
],
},
},
];
docs/
index.md
configuration.md
docs/
es/
index.md
configuration.md
plugins: [
{
name: "@squidoc/plugin-versions",
options: {
versions: [{ name: "0.1", label: "0.1" }],
},
},
{
name: "@squidoc/plugin-i18n",
options: {
defaultLocale: "en",
locales: [
{ code: "en", label: "English" },
{ code: "es", label: "Español" },
],
},
},
];
docs/
versions/
0.1/
configuration.md
es/
versions/
0.1/
configuration.md