mirror of
https://github.com/fooflington/selfdefined.git
synced 2025-04-20 16:39:09 +00:00
docs: add dev guide
This commit is contained in:
parent
5f7b24d278
commit
58ba26142c
48
11ty/documentation/development.md
Normal file
48
11ty/documentation/development.md
Normal 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
|
||||||
|
```
|
||||||
|
|
||||||
|
That’s it, actually.
|
||||||
|
|
||||||
|
## Development Mode
|
||||||
|
|
||||||
|
To start the dev server run this command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run serve
|
||||||
|
```
|
||||||
|
|
||||||
|
This will start Eleventy’s 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 Eleventy’s production build. Build files are located in `dist`.
|
@ -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
|
||||||
|
Loading…
x
Reference in New Issue
Block a user