# cedr

> Page builder

Latest version **0.1.4** (published 2016-11-18) · MIT license · 0 weekly downloads

## Install

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

## 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.4 |
| Published | 2016-11-18 |
| First published | 2016-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | antitim |
| Maintainers | antitim |
| Keywords | cedr, html, bem |

## Links

- npm: https://www.npmjs.com/package/cedr
- Repository: https://github.com/antitim/cedr
- Homepage: https://github.com/antitim/cedr#readme
- Issues: https://github.com/antitim/cedr/issues
- npm.io page: https://npm.io/package/cedr

## Dependencies (1)

- [mustache](https://npm.io/package/mustache.md) ^2.2.1

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 0.1.4 (latest) — 2016-11-18
- 0.1.3 — 2016-11-10
- 0.1.2 — 2016-11-04
- 0.1.1 — 2016-11-04
- 0.1.0 — 2016-11-03

## README

# cedr [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]

> Cedr - is a page builder from library of blocks.

## About

Generates the html page from the structure presented in the form of a js object. 
In the description of the structure of the used blocks that are in the description of library blocks.
Inspired by [BEM](https://en.bem.info/) and [bem-xjst](https://github.com/bem/bem-xjst)
Before you can use `cedr` strongly recommended to read [this methodolgy](https://en.bem.info/methodology/quick-start/)

Also may interesting:
- [gulp-cedr](https://github.com/antitim/gulp-cedr)
- [cedr-library](https://github.com/antitim/cedr-library)
- [cedr-deps](https://github.com/antitim/cedr-deps)

## Installation

```sh
$ npm install --save cedr
```

## Usage

```js
const cedr = require('cedr');

let library = {
  'page': {
    templates: {
      'page': '<!DOCTYPE html><html><head></head><body class="{{ className }}">{{{ content }}}</body></html>',
      '__header': '<div class="{{ className }}">This is Header: {{{ content }}}</div>'
    }
  },
  'text': {
    templates: {
      'text': '<p class="{{ className }}">{{{ content }}}</p>'
    }
  }
}

let page = {
  block: 'page',
  content: [
    {
      block: 'text',
      content: 'text'
    },
    {
      block: 'page',
      element: 'header',
      content: 'Yeah!'
    }
  ]
};

cedr(page, library); 
// Return '<!DOCTYPE html><html><head></head><body class="page"><p class="text">text</p><div class="page__header">This is Header: Yeah!</div></body></html>'
cedr(page); 
// Return '<div class="page"><div class="text">text</div><div class="page__header">Yeah!</div></div>'

```
Example with [express](http://expressjs.com/)

```js
'use strict'

const cedr = require('cedr');
const express = require('express');

const app = express();

const library = {
  'page': {
    templates: {
      'page': '<!DOCTYPE html><html><head></head><body class="{{ className }}">{{{ content }}}</body></html>',
      '__header': '<div class="{{ className }}">This is Header: {{{ content }}}</div>'
    }
  },
  'text': {
    templates: {
      'text': '<p class="{{ className }}">{{{ content }}}</p>'
    }
  }
}

app.get('/', function (req, res) {

  let page = {
    block: 'page',
    content: [
      {
        block: 'text',
        content: 'text'
      },
      {
        block: 'page',
        element: 'header',
        content: 'Yeah!'
      }
    ]
  };

  res.send(cedr(page, library));
});

app.listen(3000, function () {
  console.log('Example app listening on port 3000!')
})
```


## API
cedr can be called with or without library of blocks.

### cedr(page[, library])

#### page
Type: `Object`

The object of page. [More about page format](docs/page.md)

#### library
Type: `Object`

The object of library.

Returns a `String` of html.


## License

MIT © [antitim](http://vk.com/antitim)


[npm-image]: https://badge.fury.io/js/cedr.svg
[npm-url]: https://npmjs.org/package/cedr
[travis-image]: https://travis-ci.org/antitim/cedr.svg?branch=master
[travis-url]: https://travis-ci.org/antitim/cedr
[daviddm-image]: https://david-dm.org/antitim/cedr.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/antitim/cedr

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