# @liamnewmarch/static

> A lightweight and configurable static site generator

Latest version **0.3.2** (published 2020-05-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @liamnewmarch/static
pnpm add @liamnewmarch/static
yarn add @liamnewmarch/static
bun add @liamnewmarch/static
```

Provides the command `static`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.2 |
| Published | 2020-05-06 |
| First published | 2020-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=14.0.0 |
| Dependencies | 7 |
| Unpacked size | 15.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Liam Newmarch |
| Maintainers | liamnewmarch |
| Keywords | static, site, generator, builder, lightweight, configurable |

## Links

- npm: https://www.npmjs.com/package/@liamnewmarch/static
- Repository: https://github.com/liamnewmarch/static
- Homepage: https://github.com/liamnewmarch/static#readme
- Issues: https://github.com/liamnewmarch/static/issues
- npm.io page: https://npm.io/package/@liamnewmarch/static

## Dependencies (7)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [chokidar](https://npm.io/package/chokidar.md) ^3.4.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.0
- [commander](https://npm.io/package/commander.md) ^5.1.0
- [yaml-front-matter](https://npm.io/package/yaml-front-matter.md) ^4.1.0
- [@liamnewmarch/static-server](https://npm.io/package/@liamnewmarch/static-server.md) ^0.1.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.3.2 (latest) — 2020-05-06
- 0.3.1 — 2020-05-04

## README

# Static

__Note: Static is still experimental! Its API may, and probably will, change.__

Static is a static site generator for Node.js and is designed to be lightweight and configurable. Static doesn’t come with a templating engine out of the box, instead you’re encouraged to bring-your-own via plugins.

## Usage

```
Usage: @liamnewmarch/static [options] [command]

Lightweight static site builder

Options:
  -V, --version        output the version number
  -c, --config <path>  path to static config file (default: "static.config.js")
  -h, --help           display help for command

Commands:
  build                builds the site to the output directory
  serve                runs a local server and watches for changes
  help [command]       display help for command
```

## Project goals

### Lightweight

Dependencies are carefully considered to keep the installed size of the project low.

* [`@liamnewmarch/static-server`](https://www.npmjs.com/package/@liamnewmarch/static-server) for the local development server.
* [`chalk`](https://www.npmjs.com/package/chalk) for making the output readable.
* [`chokidar`](https://www.npmjs.com/package/chokidar) for watching files.
* [`commander`](https://www.npmjs.com/package/commander) for parsing CLI input.
* [`fs-extra`](https://www.npmjs.com/package/fs-extra) for reading and writing files.
* [`js-yaml`](https://www.npmjs.com/package/js-yaml) for parsing YAML.
* [`yaml-front-matter`](https://www.npmjs.com/package/yaml-front-matter) for reading file metadata.

## Configurable

Static is designed to be used with plugins. Plugins can add support for parsing different file types and for different rendering engines.

* `@liamnewmarch/static-plugin-nunjucks` experimental support for Nunjucks templates (`.njk`).

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