Repository files navigation

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.

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, a utility CSS framework that allows you to customize your design without touching a line of CSS
• Purgecss to remove unused selectors from your CSS, resulting in smaller CSS files
• Syntax highlighting usinghighlight.js
• A script that automatically generates asitemap.xml file
• A search bar powered byAlgolia DocSearch, and instructions on how to get started with their free indexing service
• A custom 404 page

As with all Jigsaw sites, configuration settings can be found inconfig.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 theJigsaw documentation to learn more.

// config.phpreturn ['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: 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 officialJigsaw documentation to learn more.

You can write your content using avariety of file types. By default, this starter template expects your content to be located in thesource/docs folder. If you change this, be sure to update the URL references innavigation.php.

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

---title:Navigationdescription:Building a navigation menu for your siteextends:_layouts.documentationsection:content---

Read more about Jigsaw layouts.

Any assets that need to be compiled (such as JavaScript, Less, or Sass files) can be added to thesource/_assets/ directory, and Laravel Mix will process them when runningnpm run local ornpm run production. The processed assets will be stored in/source/assets/build/ (note there is no underscore on this secondassets directory).

Then, when Jigsaw builds your site, the entire/source/assets/ directory containing your built files (and any other directories containing static assets, such as images or fonts, that you choose to store there) will be copied to the destination build folders (build_local, on your local machine).

Files that don't require processing (such as images and fonts) can be added directly to/source/assets/.

Read more about compiling assets in Jigsaw using Laravel Mix.

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

# build static files with Jigsaw./vendor/bin/jigsaw build# compile assets with Laravel Mix# options: dev, staging, productionnpm run dev