README

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
---

阅读有关 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/。

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

构建您的网站

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

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

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

laraxot / module_ticket

维护者

详细信息