selfdefined/11ty/documentation/development.md

51 lines
1.4 KiB
Markdown
Raw Normal View History

2019-11-22 13:12:50 +01:00
---
title: Development & Build
parent:
title: Documentation
href: '/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](https://www.11ty.io/) to generate the site based on the given definitions. As a module bundle we use Parcel.
Weve compiled a list of [contribution guidelines](https://github.com/selfdefined/web-app/blob/prod/CONTRIBUTING.md) to help you start working on the project.
2019-11-22 13:12:50 +01:00
## Setup
You will need to have Node and Git installed on your machine. To start developing please create a fork of the [root repository](https://github.com/selfdefined/web-app).
2019-11-22 13:12:50 +01:00
Afterwards, install the dependencies.
```bash
npm install
```
Thats it, actually.
## Development Mode
To start the dev server run this command:
```bash
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
```bash
npm run build
```
This will generate a minified CSS bundle as well as run Eleventys production build. Build files are located in `dist`.