Getting Started

Installation

Prerequisites

Before you begin, ensure you have the following installed on your system:

For Node.js on windows, I recommend using the Windows Installer (.msi), not the powershell script. Also say yes to npm and add to path if prompted during the wizard

Forking the Repository

If using GitHub, you can also use their "Fork" or "Use this template" button instead. Then clone that repo to your local machine.

Setup

Run the following command in the project root to install dependencies and setup LFS:

If you are unsure if you already ran this command, you can run it multiple times without issues.

Running

Intermark runs in two modes: Edit Mode and Production Mode.

Edit Mode

Use this mode locally to preview your site as you write, and edit the sidebar with a GUI. It rebuilds pages from source on every request. To start Intermark in Edit Mode, run:

Production Mode

This mode builds everything with various optimizations during:

Startup
Pushes to main branch of your forked repository

To start Intermark in Production Mode, run:

Previous: Introduction Next: Writing Content