jigsaw docs template

Jigsaw 文档入门模板

这是一个入门模板，用于以最少的努力为您的项目创建一个漂亮的、可定制的文档站点。您只需更改一些设置即可开始使用。

查看文档模板的预览。

安装

安装 Jigsaw 后，从项目目录运行以下命令：

./vendor/bin/jigsaw init docs

此入门模板包括常见页面类型的示例，并预先配置了：

• 完全响应式导航栏
• 侧边栏导航菜单
• Tailwind CSS，一个实用的 CSS 框架，允许您自定义设计，而无需触及任何 CSS 行
• Purgecss 从 CSS 中删除未使用的选择器，从而生成更小的 CSS 文件
• 使用highlight.js 进行语法高亮显示
• 自动生成sitemap.xml文件的脚本
• 由 Algolia DocSearch 提供支持的搜索栏，以及有关如何开始使用其免费索引服务的说明
• 自定义 404 页面

---

---

配置您的新站点

与所有 Jigsaw 站点一样，配置设置可以在config.php中找到；您可以使用特定于您的项目的设置来更新该文件中的变量。您还可以在其中添加新的配置变量以在整个站点中使用；查看 Jigsaw 文档以了解更多信息。

 // config.php
return [
    ' baseUrl ' => ' https://my-awesome-jigsaw-site.com/ ' ,
    ' production ' => false ,
    ' siteName ' => ' My Site ' ,
    ' siteDescription ' => ' Give your documentation a boost with Jigsaw. ' ,
    ' docsearchApiKey ' => '' ,
    ' docsearchIndexName ' => '' ,
    ' navigation ' => require_once ( ' navigation.php ' ),
];

提示：您还可以在该配置文件中定义任何“集合”（例如，网站贡献者的集合或博客文章的集合）。查看 Jigsaw 官方文档以了解更多信息。

---

添加内容

您可以使用各种文件类型编写内容。默认情况下，此入门模板要求您的内容位于source/docs文件夹中。如果您更改此设置，请务必更新navigation.php中的 URL 引用。

每个内容页面的第一部分包含一个 YAML 标头，指定应如何呈现它。 title属性用于动态生成每个页面的 HTML title和 OpenGraph 标签。 extends属性定义此内容文件将使用哪个父级 Blade 布局进行渲染（例如_layouts.documentation将使用source/_layouts/documentation.blade.php进行渲染），而section属性定义了期望放置此内容的 Blade“部分”进入其中。

---
title : Navigation
description : Building a navigation menu for your site
extends : _layouts.documentation
section : content
---

阅读有关拼图布局的更多信息。

---

添加资产

任何需要编译的资源（例如 JavaScript、Less 或 Sass 文件）都可以添加到source/_assets/目录中，Laravel Mix 将在运行npm run dev或npm run prod时处理它们。处理后的资源将存储在/source/assets/build/中（注意第二个assets目录中没有下划线）。

然后，当 Jigsaw 构建您的站点时，包含构建文件的整个/source/assets/目录（以及您选择存储在那里的任何包含静态资源（例如图像或字体）的其他目录）将被复制到目标构建文件夹（ build_local ，在您的本地计算机上）。

不需要处理的文件（例如图像和字体）可以直接添加到/source/assets/ 。

阅读有关使用 Laravel Mix 在 Jigsaw 中编译资源的更多信息。

---

建立您的网站

现在您已经编辑了配置变量并知道如何自定义样式和内容，让我们构建网站。

 # build static files with Jigsaw
./vendor/bin/jigsaw build

# compile assets with Laravel Mix
# options: dev, prod
npm run dev