selfdefined/11ty/documentation/development.md
2019-11-22 13:12:50 +01:00

1.2 KiB
Raw Permalink Blame History

title parent
Development & Build
title href
Documentation /documentation

This guide will walk you through the current state of the development config. Things get a bit technical here. 🤖

All file names, except stated differently, are relative to the project root.

We are using Eleventy to generate the site based on the given definitions. As a module bundle we use Parcel.

Setup

You will need to have Node and Git installed on your machine. To start developing please create a fork of the root repository.

Afterwards, install the dependencies.

npm install

Thats it, actually.

Development Mode

To start the dev server run this command:

npm run serve

This will start Eleventys development server and watch the CSS entry point for changes. The output in the console will show the local URL to use.

Eleventy Config

Configuration for Eleventy (e.g. filters and collections) are defined in .eleventy.js.

Build

To build the production site run

npm run build

This will generate a minified CSS bundle as well as run Eleventys production build. Build files are located in dist.