Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brandonbloom/html2coffeekup
Converts HTML to Coffeekup markup
https://github.com/brandonbloom/html2coffeekup
Last synced: 2 months ago
JSON representation
Converts HTML to Coffeekup markup
- Host: GitHub
- URL: https://github.com/brandonbloom/html2coffeekup
- Owner: brandonbloom
- Created: 2011-07-27T08:35:47.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2011-11-02T23:42:13.000Z (about 13 years ago)
- Last Synced: 2024-10-03T05:10:22.136Z (3 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 116 KB
- Stars: 26
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
Not fully complete, but still a huge time saver. Tested on dozens of files that only needed minor touch ups after conversion.
# Installation
```
npm install -g html2coffeekup
```
# Command Line Synopsys
```
html2coffeekup test/simple.html
```
# Example Output (for above usage)
```
doctype TODO
html ->
head ->
title 'A simple test page'
style type: 'text/css', '.foo {\n color: red\n }'
body '.awesome', ->
div '#root.super.special', ->
comment 'This page is rapidly becoming not-so-simple'
h1 'A simple test page'
p ->
text 'With some awesome text, and a'
a href: 'http://www.google.com', 'link'
text '.'
p '#paragraph_2', ->
text 'And here is an image:'
img src: 'fake/source', title: 'not really'
text 'As well as a disabled select:'
select disabled: 'disabled', ->
option 'Oh boy!'
script type: 'text/javascript', 'console.log("Hello there");\n console.log("How\'s it going?");'
span()
```
# Full Command Line Usage
```
html2coffeekup [options]
--prefix= Prepends a string to each element function call
--no-prefix Disables prefix (default)
--selectors Output css-selectors for id and classes (default)
--no-selectors Disables output of css-selectors for id and classes
--export[=] Wraps the output in a Node.js style export
--no-export Disables wrapping the output in an export (default)
```
See "Supported options" below for additional details.
# Public API
`convert(html, stream, [options], [callback])`
`html` must be a string.
`stream` is a "Writable Stream".
`options` is an optional hash. See next section for details.
`callback` is optional and passed `(error)` if something goes wrong.
### Supported options:
* `prefix` prepends a string to the begining of each element functional call. (default: `''`)
> For example, using the prefix `@` would result in `@body ->`.
* `selectors` is a boolean to toggle emitting classes and ids as a first argument to element functions as a selector string (default: `true`).
> For example, when true you get `div '#id.cls1.cls2`. When false you get `div id: "id", class: "cls1 cls2"`
* `exports` is a boolean or a string name. When truthy, wraps the output in a Node.js style function export. (default: `false`).
> When `true` you get `module.exports = ->`. When a `"foo"` you get `exports.foo = ->`
# Example REPL Session
```
coffee> {convert} = require('html2coffeekup')
{ convert: [Function] }
coffee> convert 'Github', process.stdout, -> console.log 'done!'
a href: 'http://www.github.com', 'Github'
done!
```