https://github.com/bredele/marc
:part_alternation_mark: Markdown as a dynamic template engine
https://github.com/bredele/marc
Last synced: 9 months ago
JSON representation
:part_alternation_mark: Markdown as a dynamic template engine
- Host: GitHub
- URL: https://github.com/bredele/marc
- Owner: bredele
- Created: 2014-03-09T21:52:50.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-04-28T15:38:56.000Z (about 6 years ago)
- Last Synced: 2025-04-11T02:43:32.233Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 548 KB
- Stars: 148
- Watchers: 5
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: Readme.md
- Changelog: History.md
Awesome Lists containing this project
README
# marc
> Markdown as a dynamic template engine
Markdown is a text-to-HTML conversion tool for web writers. With a plain easy-to-write text you can create a website, a blog, a todo list, a slideshow or even a project presentation (like I've done here on github). However it is mostly used to generate static content.
`marc` makes markdown a dynamic conversion engine with integrated **templates** that **updates automatically** when the underlying data changes. It also allows you to create **filters** or **partials** and makes easy to create content dynamically from a database.
## Installation
`marc` works on both client and server side:
with [component](http://component.io):
$ component install bredele/marc
with [nodejs](http://nodejs.org):
$ npm install marc
### Command line
Install globally:
$ npm install -g marc
```
Usage: marc [] []
Examples:
# pass an input and output file:
$ marc input.md output.html
```
## Usage
`marc` can be initialized with an optional data.
```js
var marc = require('marc')(data);
```
### Basic
`marc` generates html from markdown.
```js
marc('I am using __markdown__.');
//
I am using markdown.
```
### Templating
`marc` is also a template engine! It makes markdown less static and allows you to substitute variables (double brackets `{{}}` with any data.
```js
marc.set('label', 'marc!');
marc('I am using __markdown__ with {{label}}.', true);
//
I am using markdown with marc!.
```
### Dynamic
`marc` makes your markdown dynamic! It updates automatically when the underlying data changes.
```js
marc('I am using __narkdown__ with {{label}}.', function(val) {
//
I am using markdown with marc!.
//I am using markdown with github.
});
marc.set('label', 'marc!');
marc.set('label', 'github');
```
## Features
### Partials
`marc` allows you to use partials (`{> name }`)
```js
marc.partial('hello', '__{{ label }}__!');
marc('This is a partial: {> hello }.', function(val){
//
This is a partial: hello world!
});
marc.set('label', 'hello world');
```
### Filters
`marc` allows you to apply filter(s) to your markdown in a unix-like fashion.
```js
marc.filter('hello', function(str) {
return 'hello ' + str + '!';
});
marc('# {{ name } | hello}.', true);
//
hello world!.
```
> filters can be chained and reused multiple times.
### Config
`marc` use [marked](https://github.com/chjj/marked) and allows to set markdown options as following:
```js
//single options
marc.config('sanitize', true);
//multiple options
marc.config({
gfm:true,
smartypants:true
})
```
or get options:
```js
marc.config('sanitize');
```
## API
### General
#### marc(str, fn)
Generate HTML from markdown.
```js
marc('I am using __markdown__.');
marc('hello __markdown__ with {{label}}', true);
marc('hello __markdown__ with {{label}}', function(val) {
//do something on change
});
```
Second argument is optional (substitute template variables if truethy).
#### marc.filter(str, fn)
Add template filter.
```js
marc.filter('hello', function(str) {
return 'hello ' + str + '!';
});
marc('# {{ label } | hello}', true);
```
Second argument is a function and takes the template variable as argument.
#### marc.partial(name, str)
Add partial.
```js
marc.partial('hello','__{{ name }}__');
marc('hello {> hello }', true);
```
#### marc.config(name, val)
Set markdown options.
```js
marc.config('sanitize','true');
marc.config({
sanitize: false,
gfm: true
});
```
or get options:
```js
marc.config('sanitize');
```
### Datastore
`marc` is basically a mixin of [datastore](http://github.com/bredele/datastore) and exposes its entire api through the option `marc.data`. Here's an example of computed property:
```js
marc.data.compute('name',function() {
return this.firstName + ' ' + this.lastName;
});
```
However, `marc` overrides some of the most used store handler such as `get` and `set` just for the beauty of code.
#### .set(name, data)
Set an attribute `name` with data object.
object store:
```js
marc.set('nickname','bredele');
```
Or update data:
```js
marc.set({
nickname: 'olivier',
lastname: 'wietrich'
});
```
#### .get(name)
Get an attribute `name`.
```js
marc.get('nickname');
```
## License
The MIT License (MIT)
Copyright (c) 2014
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.