docs: add dev guide

This commit is contained in:
Oscar 2019-11-22 13:12:50 +01:00
parent 5f7b24d278
commit 58ba26142c
2 changed files with 49 additions and 0 deletions

View File

@ -0,0 +1,48 @@
---
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.
## 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.
```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`.

View File

@ -6,3 +6,4 @@ As always, documentation is a work in progress. However, this is what we have so
- [Examples](/documentation/examples/): Grab-and-go definition examples - [Examples](/documentation/examples/): Grab-and-go definition examples
- [Front Matter](/documentation/front-matter/): Configuration possibilities through front matter - [Front Matter](/documentation/front-matter/): Configuration possibilities through front matter
- [Development & Build](/documentation/development/): Notes for developing the site