Skip to content

Getting Started

Jump to bottom
dandevri edited this page Jun 1, 2019 · 5 revisions

Prerequisites

Make sure you have Node.js® installed in your machine. For detailed instructions: Installing Node

You can also use Node Version Manager (NVM) to manage your node install.

Install

Follow these steps to get started:

  1. Clone the project
$ git clone https://github.com/dandevri/static-site-starter.git
  1. Navigate to the project folder
$ cd static-site-starter
  1. Install project-specific dependencies with:
$ npm install
  1. Then do the
$ npm run dev

to start the live-reloadzz on a local development server.

Folders

  |- _data/ < general metadata about the site
  |- _includes/ < components
  |- pages/ < pages and templates
  |- css/ < postcss transforms
  |- blog/ < posts written in markdown
  |- package.json < npm scripts
  |- .[..] < dotfiles for configuration or linting

MIT © Danny de Vries | A boilerplate for building static websites

Clone this wiki locally