# spindle-cli

> a minimalistic static site generator

Latest version **0.1.0** (published 2018-06-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install spindle-cli
pnpm add spindle-cli
yarn add spindle-cli
bun add spindle-cli
```

Provides the command `spin`.

## 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.1.0 |
| Published | 2018-06-15 |
| First published | 2018-06-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 43.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Vincent Abruzzo |
| Maintainers | thoughtbyte |

## Links

- npm: https://www.npmjs.com/package/spindle-cli
- Repository: https://github.com/thoughtbyte/spindle
- Homepage: https://github.com/thoughtbyte/spindle#readme
- Issues: https://github.com/thoughtbyte/spindle/issues
- npm.io page: https://npm.io/package/spindle-cli

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^6.0.1
- [inquirer](https://npm.io/package/inquirer.md) ^6.0.0
- [commander](https://npm.io/package/commander.md) ^2.15.1

## Recent versions

- 0.1.0 (latest) — 2018-06-15

## README

# spindle: minimal site building with a modern toolset

This project is (currently) a proof of concept. This is an attempt to see how powerful a static site generator can be created on top of the modern JavaScript toolset, namely [parcel](https://parceljs.org/), an amazing build tool, and [commander](https://github.com/tj/commander.js/) and [inquirer](https://github.com/SBoudrias/Inquirer.js/).

## instructions

- install spindle globally: `yarn global add spindle-cli` or `npm install -g spindle-cli`
- all of the following commands are available and should be run at the project root:
  1.  creating a new site: `spin site [name]` (after site is created, install dependencies in new site directory)
  2.  creating a new post: `spin post [name]` this creates a post pug file and it's corresponding markdown file
  3.  creating a new page: `spin page [name]`
- `yarn dev` to run the dev server; make changes to `.pug`, `.md`, `.scss`, or `.js` files and the dev server will hot reload
- `yarn build` to build the project inside a `dist` directory
- pages and posts can contain `yaml` front matter, the functionality for this was worked into a separate custom pug plugin for parcel (no need to install this separately, just linking to it here for reference): [parcel-plugin-pug-front-matter](https://github.com/thoughtbyte/parcel-plugin-pug-front-matter)

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