jigsaw docs template

Начальный шаблон Jigsaw Docs

Это стартовый шаблон для создания красивого, настраиваемого сайта документации для вашего проекта с минимальными усилиями. Вам нужно будет всего лишь изменить несколько настроек, и все готово.

Просмотрите предварительный просмотр шаблона документов.

Установка

После установки 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 . Если вы измените это, обязательно обновите ссылки URL-адресов в navigation.php .

Первый раздел каждой страницы контента содержит заголовок 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/ , и Laravel Mix обработает их при запуске npm run dev или npm run prod . Обработанные ресурсы будут храниться в /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