README

这是一个创建美丽、可定制的项目文档站点的入门模板，只需付出最少的努力。你只需更改几个设置，就可以立即开始。

查看文档模板的预览。

安装

在安装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 "section"。

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

了解更多关于Jigsaw布局的信息。

添加资产

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

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

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

在Jigsaw中使用Laravel Mix编译资源的相关信息，请查看更多信息。

构建您的网站

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

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

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