DEPOT is built with an amazing static site from Jigsaw.
- PHP >= 7.1
- Composer
- Node.js
- NPM
Check detail at Jigsaw System Requirement
- Clone DEPOT Repository
git clone https://github.com/pt-dot/depot.git- Navigate to DEPOT's directory then run composer for installation
composer install- Run locally with command:
./vendor/bin/jigsaw serve- Navigate your browser using address
http://localhost:8000
You can write your content using a variety of 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.
Any assets that need to be compiled (such as JavaScript, Less, or Sass files) can be added to the source/_assets/ directory, and Laravel Mix will process them when running npm run local or npm run production. The processed assets will be stored in /source/assets/build/ (note there is no underscore on this second assets 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, production
npm run devCurrently this site is hosted using Netlify and you may access it at DEPOT.
If you want to host with your version site to another Netlify host, click Deploy to Netlify button
All DOT's Ranger may contribute to fix, ask question, or propose a handbook into DEPOT Platform.
- Ask a Question: Open Github issue and explain your question
- Fix or propose content: Fork repo, make Pull Request and explain your fix
- Management will review your PR or issue.
- For non DOT's Ranger, you can submit PR to fix minor issue such as typo or UI glitch, etc.