ThemeMountain Documentation

This uses Jigsaw to generate a static site for our documentation.

System Requirements

1. PHP + Composer

   Jigsaw needs PHP7 installed on your machine. If you're on Windows, read this.

   You also need to have Composer installed.

2. Node.js, NPM, and Git

   For Laravel Mix to work (compiling SASS, BrowserSync, etc.), you need to have Node.js and NPM installed on your system. Additionally, for deploying to GitHub, you'll also need Git installed.

Getting Started

1. Clone this repo

   Use your preferred Git GUI to clone this repo, or run this in your terminal:

   git clone https://github.com/ThemeMountain/docs myFolder

   Where myFolder is the custom folder name in which to clone the repo. This folder will be created relative to the path at which you execute the git clone command in your terminal. If you don't specify a folder name after the repo URL, a docs folder name will be used (the repo name).

2. Install JS dependencies

   npm install

   Windows note: you might run into an issue with NPM not being able to install node-sass. This can happen because node-sass requires node-gyp, which in turn requires Python. In this case, use Option 1 from here.

3. Install PHP dependencies

   composer install

   If you get an error about composer not being recognized as a command, make sure ~/.composer/vendor/bin is in your $PATH.

4. Building and Previewing

   To build the site when developing locally, run:

   npm run dev

   To build the production version:

   npm run prod

   To have Webpack watch for file changes:

   npm run watch

   This will also run BrowserSync and will open the site in a new tab.

Writing Documentation

Each documentation lives in its own folder, inside the source folder. All folders in source that do not start with _ will be parsed by Jigsaw.

TBD.