PHPackages                             tightenco/jigsaw-docs-template - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. tightenco/jigsaw-docs-template

ActiveLibrary[Templating & Views](/categories/templating)

tightenco/jigsaw-docs-template
==============================

Documentation starter template for Jigsaw static site generator by Tighten

v1.2.2(5mo ago)5026.9k↑200%20[3 PRs](https://github.com/tighten/jigsaw-docs-template/pulls)MITBladeCI passing

Since Dec 21Pushed 1mo ago11 watchersCompare

[ Source](https://github.com/tighten/jigsaw-docs-template)[ Packagist](https://packagist.org/packages/tightenco/jigsaw-docs-template)[ RSS](/packages/tightenco-jigsaw-docs-template/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (5)Dependencies (2)Versions (25)Used By (0)

Jigsaw Docs Starter Template
============================

[](#jigsaw-docs-starter-template)

This is a starter template for creating a beautiful, customizable documentation site for your project with minimal effort. You’ll only have to change a few settings and you’re ready to go.

[View a preview of the docs template.](http://jigsaw-docs-template.tighten.co/)

Installation
------------

[](#installation)

After installing Jigsaw, run the following command from your project directory:

```
./vendor/bin/jigsaw init docs
```

This starter template includes samples of common page types, and comes pre-configured with:

- A fully responsive navigation bar
- A sidebar navigation menu
- [Tailwind CSS](https://tailwindcss.com/), a utility CSS framework that allows you to customize your design without touching a line of CSS
- Syntax highlighting using [Prism.js](https://prismjs.com/)
- A script that automatically generates a `sitemap.xml` file
- A search bar powered by [Algolia DocSearch](https://community.algolia.com/docsearch/), and instructions on how to get started with their free indexing service
- A custom 404 page

---

[![Docs starter template screenshot](https://user-images.githubusercontent.com/357312/50345478-40170c00-04fd-11e9-856c-ad46d1ac45cb.png)](https://user-images.githubusercontent.com/357312/50345478-40170c00-04fd-11e9-856c-ad46d1ac45cb.png)

---

### Configuring your new site

[](#configuring-your-new-site)

As with all Jigsaw sites, configuration settings can be found in `config.php`; you can update the variables in that file with settings specific to your project. You can also add new configuration variables there to use across your site; take a look at the [Jigsaw documentation](http://jigsaw.tighten.co/docs/site-variables/) to learn more.

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

> Tip: This configuration file is also where you’ll define any "collections" (for example, a collection of the contributors to your site, or a collection of blog posts). Check out the official [Jigsaw documentation](https://jigsaw.tighten.co/docs/collections/) to learn more.

---

### Adding Content

[](#adding-content)

You can write your content using a [variety of file types](http://jigsaw.tighten.co/docs/content-other-file-types/). By default, this starter template expects your content to be located in the `source/docs` folder. If you change this, be sure to update the URL references in `navigation.php`.

The first section of each content page contains a YAML header that specifies how it should be rendered. The `title` attribute is used to dynamically generate HTML `title` and OpenGraph tags for each page. The `extends` attribute defines which parent Blade layout this content file will render with (e.g. `_layouts.documentation` will render with `source/_layouts/documentation.blade.php`), and the `section` attribute defines the Blade "section" that expects this content to be placed into it.

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

[Read more about Jigsaw layouts.](https://jigsaw.tighten.co/docs/content-blade/)

---

### Adding Assets

[](#adding-assets)

Any assets that need to be compiled, such as JavaScript or CSS using Tailwind, can be added to the `source/_assets/` directory. Vite will process them when running `npm run dev` or `npm run build`, and the processed assets will be stored in `/build_local` or `/build_production`, respectively.

Files that don't need processing (like images and fonts) can be placed in `/source/assets/` and will be included in the build as-is.

[Read more about compiling assets in Jigsaw using Vite.](http://jigsaw.tighten.co/docs/compiling-assets/)

---

Building Your Site
------------------

[](#building-your-site)

Now that you’ve edited your configuration variables and know how to customize your styles and content, let’s build the site.

```
# run development server
npm run dev

# build static files with Vite
npm run build
```

###  Health Score

57

—

FairBetter than 98% of packages

Maintenance81

Actively maintained with recent releases

Popularity40

Moderate usage in the ecosystem

Community24

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 59.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~148 days

Recently: every ~352 days

Total

18

Last Release

173d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bbd8d70be13fce77c0fc93f9000768b3679cfb36aa1017892ffb571445e21f2f?d=identicon)[damiani](/maintainers/damiani)

---

Top Contributors

[![damiani](https://avatars.githubusercontent.com/u/357312?v=4)](https://github.com/damiani "damiani (114 commits)")[![mattstauffer](https://avatars.githubusercontent.com/u/151829?v=4)](https://github.com/mattstauffer "mattstauffer (19 commits)")[![bakerkretzmar](https://avatars.githubusercontent.com/u/18192441?v=4)](https://github.com/bakerkretzmar "bakerkretzmar (18 commits)")[![Cameron-elliott](https://avatars.githubusercontent.com/u/158162163?v=4)](https://github.com/Cameron-elliott "Cameron-elliott (17 commits)")[![nicodevs](https://avatars.githubusercontent.com/u/3766839?v=4)](https://github.com/nicodevs "nicodevs (10 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (6 commits)")[![gcavanunez](https://avatars.githubusercontent.com/u/9332696?v=4)](https://github.com/gcavanunez "gcavanunez (3 commits)")[![saulsolorzano](https://avatars.githubusercontent.com/u/1031658?v=4)](https://github.com/saulsolorzano "saulsolorzano (1 commits)")[![clemblanco](https://avatars.githubusercontent.com/u/668419?v=4)](https://github.com/clemblanco "clemblanco (1 commits)")[![fletch3555](https://avatars.githubusercontent.com/u/1387843?v=4)](https://github.com/fletch3555 "fletch3555 (1 commits)")[![rickwest](https://avatars.githubusercontent.com/u/24735291?v=4)](https://github.com/rickwest "rickwest (1 commits)")

---

Tags

bladejigsawlaravelstatic-sitestatic-site-generatortailwindcsstemplatedocumentationgeneratortemplatestaticsitestarterdocsjigsaw

### Embed Badge

![Health badge](/badges/tightenco-jigsaw-docs-template/health.svg)

```
[![Health](https://phpackages.com/badges/tightenco-jigsaw-docs-template/health.svg)](https://phpackages.com/packages/tightenco-jigsaw-docs-template)
```

###  Alternatives

[tightenco/jigsaw-blog-template

Blog starter template for Jigsaw static site generator by Tighten

9464.0k](/packages/tightenco-jigsaw-blog-template)[tightenco/jigsaw

Simple static sites with Laravel's Blade.

2.2k438.5k29](/packages/tightenco-jigsaw)[rickwest/jigsaw-clean-blog

Blog starter template for Jigsaw static site generator by Tighten

111.4k](/packages/rickwest-jigsaw-clean-blog)[anourvalar/office

Generate documents from existing Excel & Word templates | Export tables to Excel (Grids)

24085.2k](/packages/anourvalar-office)[aschmelyun/cleaver

A blazing-fast static site generator using Laravel's Blade templating engine

2961.0k](/packages/aschmelyun-cleaver)[tomatophp/filament-plugins

Manage your modules as a plugin system with plugin generator

644.7k2](/packages/tomatophp-filament-plugins)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)