# siteelm

> a static site generator for Elm

Latest version **0.3.2** (published 2020-06-23) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install siteelm
pnpm add siteelm
yarn add siteelm
bun add siteelm
```

Provides the command `siteelm`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2020-06-23 |
| First published | 2019-09-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.2 |
| Dependencies | 13 |
| Unpacked size | 812.9 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19 |
| Author | nikueater |
| Maintainers | nikueater |
| Keywords | elm, static site generator |

## Links

- npm: https://www.npmjs.com/package/siteelm
- Repository: https://github.com/nikueater/siteelm
- Issues: https://github.com/nikueater/siteelm/issues
- npm.io page: https://npm.io/package/siteelm

## Dependencies (13)

- [tmp](https://npm.io/package/tmp.md) ^0.1.0
- [glob](https://npm.io/package/glob.md) ^7.1.6
- [jsdom](https://npm.io/package/jsdom.md) ^16.2.2
- [watch](https://npm.io/package/watch.md) ^1.0.2
- [express](https://npm.io/package/express.md) ^4.17.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [prompts](https://npm.io/package/prompts.md) ^2.3.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [traverse](https://npm.io/package/traverse.md) ^0.6.6
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [parsimmon](https://npm.io/package/parsimmon.md) ^1.13.0
- [express-ws](https://npm.io/package/express-ws.md) ^4.0.0
- [html-minifier](https://npm.io/package/html-minifier.md) ^4.0.0

## Recent versions

- 0.3.2 (latest) — 2020-06-23
- 0.3.1 — 2020-05-03
- 0.3.0 — 2020-05-03
- 0.2.12 — 2020-04-13
- 0.2.11 — 2020-04-03
- 0.2.10 — 2020-03-15
- 0.2.9 — 2020-03-02
- 0.2.8 — 2020-03-01
- 0.2.7 — 2020-02-26
- 0.2.6 — 2020-02-24
- 0.2.5 — 2020-02-24
- 0.2.4 — 2020-02-23
- 0.2.3 — 2019-12-30
- 0.2.2 — 2019-12-30
- 0.2.1 — 2019-12-29
- … 11 more at https://npm.io/package/siteelm/versions

## README

<img src='https://github.com/nikueater/siteelm/raw/master/res/img/siteelm.svg?sanitize=true' width='420' alt='siteelm'>


demo: https://siteelm.netlify.com/ ([source](/res/scaffold/basic))

## about
It's just another static site generator for Elm, but has some features.

- you can write YAML in preamble sections 
- in a preamble, you can load external YAML files
- it's easy to mix dynamic Elm components
- simple rules to use

## concept
to make a template, what you need to do is writing preamble models, their decoder, and two functions return Html Never (for HEAD and BODY)

<img src='https://github.com/nikueater/siteelm/raw/master/res/img/about.svg?sanitize=true' width='420' alt='siteelm'>


## usage
### install
```sh
% npm install -g elm
% npm install -g siteelm
```
or if you'd like to do everything locally,
```sh
% npm install -D elm siteelm
```
in this case, type _"% npx siteelm 〜"_ instead of _"% siteelm 〜"_ 

### initialize project
```sh
% mkdir mysite
% cd mysite
% siteelm init
```
Then you'll see a scaffold in the directory.


### developing
```sh
% cd mysite
% siteelm server -d
```
Then access "http://localhost:3000/"  
The server supports file watching and auto reloading.
If you don't need the server, use `siteelm watch` instead.

### building
```sh
% cd mysite
% siteelm make -o
```

---
_Source: https://npm.io/package/siteelm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._