# blogoid

> Simple markdown blog generator

Latest version **0.0.4** (published 2018-04-21) · MIT license · 0 weekly downloads

## Install

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

Provides the command `blogoid`.

## 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.0.4 |
| Published | 2018-04-21 |
| First published | 2017-06-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 132.4 KB |
| Known vulnerabilities | 0 (+7 in 3 direct dependencies) |
| Install scripts | no |
| Author | hamadu |
| Maintainers | hamadu |

## Links

- npm: https://www.npmjs.com/package/blogoid
- npm.io page: https://npm.io/package/blogoid

## Dependencies (7)

- [ejs](https://npm.io/package/ejs.md) ^2.5.6
- [opn](https://npm.io/package/opn.md) ^5.1.0
- [glob](https://npm.io/package/glob.md) ^7.0.5
- [marked](https://npm.io/package/marked.md) ^0.3.9
- [date-fns](https://npm.io/package/date-fns.md) ^1.28.5
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [node-static](https://npm.io/package/node-static.md) ^0.7.9

## Recent versions

- 0.0.4 (latest) — 2018-04-21
- 0.0.3 — 2017-07-09
- 0.0.2 — 2017-07-09
- 0.0.1 — 2017-06-22

## README

# blogoid

[![CircleCI](https://circleci.com/gh/hamadu/blogoid.svg?style=svg)](https://circleci.com/gh/hamadu/blogoid)

[![Coverage Status](https://coveralls.io/repos/github/hamadu/blogoid/badge.svg?branch=master)](https://coveralls.io/github/hamadu/blogoid?branch=master)

simple blog(-ish) site generation tool

## usage

```
Usage: blogoid [options]

Options:

  -s, --scaffold       scaffold sample files and exit
  -h, --help           output usage information
  -V, --version        output the version number
  -c, --config [path]  path to the config.json
  -o, --out [path]     output path
  -p, --preview        preview after generate
```

## config.json

```
{
  "title": "Blog title",                    # site title
  "author": "Your name",                    # site author(s)
  "entries": "src/entries/**/*.md",         # path to the entries
  "static": {                               # path of the static files(it just copy&pasted)
    "styles/custom.css": "src/styles/custom.css"
  },
  "pages": {                                # page to the non-entry pages
    "index.html": "src/pages/index.html",
    "about.html": "src/pages/about.html"
  },
  "templates": {                            # name and path of templates
    "entry": "src/templates/entry.html",
    "tag": "src/templates/tag.html"
  }
}

```

## try it

```
$ npm install -g blogoid
$ blogoid -s --out sample
$ blogoid --config sample/config.json --out sample/out -p
```

This will output html/css files to `sample/out` and previewed in http://localhost:8080/ automatically. (Ctrl-c to stop)

## LICENSE

MIT

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