jigsaw docs template

Templat Pemula Dokumen Jigsaw

Ini adalah template awal untuk membuat situs dokumentasi yang indah dan dapat disesuaikan untuk proyek Anda dengan sedikit usaha. Anda hanya perlu mengubah beberapa pengaturan dan Anda siap berangkat.

Lihat pratinjau templat dokumen.

Instalasi

Setelah menginstal Jigsaw, jalankan perintah berikut dari direktori proyek Anda:

./vendor/bin/jigsaw init docs

Templat pemula ini mencakup contoh jenis halaman umum, dan telah dikonfigurasikan sebelumnya dengan:

• Bilah navigasi yang sepenuhnya responsif
• Menu navigasi bilah sisi
• Tailwind CSS, kerangka kerja CSS utilitas yang memungkinkan Anda menyesuaikan desain tanpa menyentuh sebaris pun CSS
• Pembersihan untuk menghapus pemilih yang tidak digunakan dari CSS Anda, sehingga menghasilkan file CSS yang lebih kecil
• Penyorotan sintaks menggunakan highlight.js
• Skrip yang secara otomatis menghasilkan file sitemap.xml
• Bilah pencarian yang didukung oleh Algolia DocSearch, dan petunjuk tentang cara memulai layanan pengindeksan gratis mereka
• Halaman 404 khusus

---

---

Mengonfigurasi situs baru Anda

Seperti semua situs Jigsaw, pengaturan konfigurasi dapat ditemukan di config.php ; Anda dapat memperbarui variabel dalam file tersebut dengan pengaturan khusus untuk proyek Anda. Anda juga dapat menambahkan variabel konfigurasi baru di sana untuk digunakan di seluruh situs Anda; lihat dokumentasi Jigsaw untuk mempelajari lebih lanjut.

 // 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 ' ),
];

Tip: File konfigurasi ini juga merupakan tempat Anda menentukan "koleksi" apa pun (misalnya, kumpulan kontributor situs Anda, atau kumpulan postingan blog). Lihat dokumentasi resmi Jigsaw untuk mempelajari lebih lanjut.

---

Menambahkan Konten

Anda dapat menulis konten Anda menggunakan berbagai jenis file. Secara default, templat pemula ini mengharapkan konten Anda ditempatkan di folder source/docs . Jika Anda mengubahnya, pastikan untuk memperbarui referensi URL di navigation.php .

Bagian pertama setiap halaman konten berisi header YAML yang menentukan cara merendernya. Atribut title digunakan untuk menghasilkan title HTML dan tag OpenGraph secara dinamis untuk setiap halaman. Atribut extends mendefinisikan tata letak Blade induk mana yang akan merender file konten ini (misalnya _layouts.documentation akan merender dengan source/_layouts/documentation.blade.php ), dan atribut section mendefinisikan "bagian" Blade yang mengharapkan konten ini ditempatkan ke dalamnya.

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

Baca selengkapnya tentang tata letak Jigsaw.

---

Menambah Aset

Aset apa pun yang perlu dikompilasi (seperti file JavaScript, Less, atau Sass) dapat ditambahkan ke direktori source/_assets/ , dan Laravel Mix akan memprosesnya saat menjalankan npm run dev atau npm run prod . Aset yang diproses akan disimpan di /source/assets/build/ (perhatikan tidak ada garis bawah pada direktori assets kedua ini).

Kemudian, ketika Jigsaw membangun situs Anda, seluruh direktori /source/assets/ yang berisi file yang Anda buat (dan direktori lain yang berisi aset statis, seperti gambar atau font, yang Anda pilih untuk disimpan di sana) akan disalin ke folder build tujuan ( build_local , di mesin lokal Anda).

File yang tidak memerlukan pemrosesan (seperti gambar dan font) dapat ditambahkan langsung ke /source/assets/ .

Baca selengkapnya tentang kompilasi aset di Jigsaw menggunakan Laravel Mix.

---

Membangun Situs Anda

Sekarang setelah Anda mengedit variabel konfigurasi dan mengetahui cara menyesuaikan gaya dan konten, mari buat situsnya.

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

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