# whipsnap

> Build a website focussed around posts, super simple and all in JS

Latest version **0.1.1** (published 2020-04-13) · ISC license · 0 weekly downloads

## Install

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

Provides the command `whipsnap`.

## 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.1 |
| Published | 2020-04-13 |
| First published | 2020-04-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 9.7 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | alexanderburley |
| Maintainers | burlzad |

## Links

- npm: https://www.npmjs.com/package/whipsnap
- Repository: https://github.com/alexanderburley/whipper-snapper
- Homepage: https://github.com/alexanderburley/whipper-snapper#readme
- Issues: https://github.com/alexanderburley/whipper-snapper/issues
- npm.io page: https://npm.io/package/whipsnap

## Dependencies (4)

- [promptly](https://npm.io/package/promptly.md) ^3.0.3
- [showdown](https://npm.io/package/showdown.md) ^1.9.1
- [commander](https://npm.io/package/commander.md) ^5.0.0
- [github-markdown-css](https://npm.io/package/github-markdown-css.md) ^3.0.1

## Recent versions

- 0.1.1 (latest) — 2020-04-13
- 0.1.0 — 2020-04-13
- 0.0.1 — 2020-04-11

## README

# Whipsnap

Whipsnap is a JS based content generator. With a preference towards posts and static website. This is currently a work in progress

## Install

```bash
# CLI
npm i -g whipsnap
```

```
npm i --save whipsnap
```

## Usage

Whipsnap can be used via CLI or as part of an application. You will need to configure your project in the following structure. An output directory will be created called `out/` containing a static website.

```
assets/
    stylesheets/
        whipsnap.css         Main CSS file (At present defauls to github bootstrap css)
config/
    index.js                Configuration file, usage will be describe below.
pages/
    xxx.md                  The pages directory will contain static pages which will be pulled in and able to be referenced.
posts/
    YYYY-MM-DD.md           These are `blog` posts that will be displayed on the main page.
```

_CSS_ - All CSS should go into a single file - whipper.css within the stylesheets folder.

_Configuration_ - Represented by config.js or config/index.js module.

_Navigation_ - All information will be contained within the key `navigation` and will configure the navigation bar.

```javascript
module.exports = {
  navigation: {
    brand: {
      text: 'AB',
      value: 'index',
    },
    items: [
      {
        text: 'Home',
        value: 'index',
      },
      {
        text: 'About Me',
        value: 'about-me',
      },
      {
        text: 'Contact',
        value: 'contact',
      },
    ],
  },
};
```

_Pages_ - Static pages such as `About Me` which should be written in Markdown and will be auto compiled.

_Posts_ - Will appear in a listed format on the home page.

### CLI

```
whipsnap build -d path/to/directory
```

### Node

```
require('whipsnap').build(__dirname)
```

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