# creole
> Creole parser
Latest version **0.0.0** (published 2013-01-03) · 0 weekly downloads
## Install
```sh
npm install creole
pnpm add creole
yarn add creole
bun add creole
```
## 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.0 |
| Published | 2013-01-03 |
| First published | 2013-01-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | shin1morita@gmail.com |
| Maintainers | shin1m |
## Links
- npm: https://www.npmjs.com/package/creole
- Repository: https://github.com/shin1m/creole.js
- npm.io page: https://npm.io/package/creole
## Recent versions
- 0.0.0 (latest) — 2013-01-03
## README
# creole.js [](http://travis-ci.org/shin1m/creole.js)
creole.js is a [Creole 1.0](http://wikicreole.org/wiki/Creole1.0) parser for javascript.
It can run on both client side and server side.
## How to Use
class Builder
start: (name, options) ->
end: ->
text: (value) ->
require('creole').parse new Builder, 'creole...'
## Example Builder
In html.coffee:
class Builder
constructor: (@e, @u) -> @context = []
bold:
start: -> @u ''
end: -> @u ''
...
link:
start: (options) ->
@u ''
end: -> @u ''
...
start: (name, options) ->
handler = @[name]
if handler?
@context.push handler
handler.start.call @, options
else
@context.push null
end: ->
@context.pop()?.end.call @
text: (value) -> @e value
exports = module?.exports ? {}
window.html = exports if window?
exports.Builder = Builder
## Client Side Example
In demo.html:
creole.js Live Demo
## Server Side Example
In app.coffee:
...
creole = require 'creole'
html = require 'html'
app.get '/', (req, res) ->
res.render 'index',
creole: (escaped, unescaped, content) ->
creole.parse new html.Builder(escaped, unescaped), content
content: '''
= creole.js Live Demo
creole.js is a [[http://wikicreole.org/wiki/Creole1.0|Creole 1.0]] parser for javascript.
It can run on both client side and server side.
'''
...
In index.jade:
.preview
- creole(function(value) {
= value
- }, function(value) {
!= value
- }, content)
## License
The MIT License (MIT)
Copyright (c) 2012 Shin-ichi MORITA
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.
---
_Source: https://npm.io/package/creole · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._