# hopcms

> A dynamic static site generator

Latest version **1.0.3** (published 2017-11-25) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2017-11-25 |
| First published | 2014-12-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Ivo de Kler |
| Maintainers | w0ps |
| Keywords | dynamic static site, cms, experimental |

## Links

- npm: https://www.npmjs.com/package/hopcms
- Repository: https://github.com/w0ps/hop
- Homepage: https://github.com/w0ps/hop#readme
- Issues: http://github.com/w0ps/hop
- npm.io page: https://npm.io/package/hopcms

## Dependencies (12)

- [jade](https://npm.io/package/jade.md) *
- [less](https://npm.io/package/less.md) *
- [async](https://npm.io/package/async.md) *
- [gzippo](https://npm.io/package/gzippo.md) *
- [watchr](https://npm.io/package/watchr.md) *
- [express](https://npm.io/package/express.md) 3.0.0rc4
- [request](https://npm.io/package/request.md) *
- [socket.io](https://npm.io/package/socket.io.md) *
- [underscore](https://npm.io/package/underscore.md) *
- [imagemagick](https://npm.io/package/imagemagick.md) *
- [node-schedule](https://npm.io/package/node-schedule.md) *
- [less-middleware](https://npm.io/package/less-middleware.md) *

## Recent versions

- 1.0.3 (latest) — 2017-11-25
- 1.0.2 — 2016-09-03
- 1.0.1 — 2015-11-06
- 1.0.0 — 2015-11-05
- 0.1.0 — 2015-06-30
- 0.0.8 — 2015-03-22
- 0.0.7 — 2015-03-22
- 0.0.6 — 2015-03-22
- 0.0.5 — 2015-01-15
- 0.0.4 — 2014-12-21
- 0.0.3 — 2014-12-21
- 0.0.2 — 2014-12-21
- 0.0.1 — 2014-12-10

## README

hop
===

quick and dirty CMS featuring automated asset loading, socket.io driven page refreshes and image scaling + a very basic lightbox

***Installation instructions***
after you `npm install` and require this module, make sure you have imagemagick installed (osx: with brew works nicely)
and make sure you link libpng.
`sudo chown -R $(whoami):admin /usr/local`
`brew link libpng`


***Basic usage:***

clone the repo, run npm install and get crackin'!

Create folders in content/, they will be sections of your website

Create subfolders in these, and they will be items.

Add images to items or sections and they will be included

Add stylesheets (css/less) and they will be rendered and loaded

Add javascripts and they will be loaded

Add .txt files and they will be added to the item or section

***special filenames:***
logo.(jpg/png): will be placed in site header

background.(jpg/png) will be placed at the respective page as a background

title.txt: will replace the title for the item or section

subtitle.txt: will be placed as a subtitle

introdution.txt: will be placed on the overview page, and if present, allows item to be viewed exclusively, and hides other content

body.txt: displayed below introduction in item or section view, depending on introduction.txt presence

*.txt: displayed below body and before footer

footer.txt: will be displayed lowest

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