marcup
A simple markup language that allows you to write a modified form of HTML in CoffeeScript.
Last updated 7 years ago by tommyschaefer .
Repository · Original npm · Tarball · package.json
$ cnpm install marcup 
SYNC missed versions from official npm registry.

#Marcup

Marcup is a simple markup language that runs within CoffeeScript. This is a very simple implementation and isn't very functional, but I'm hoping to change that!

##Execution

This program can be used in two different ways. The first is by requiring the main file manually and executing in one file:

Markup = require(#path_to_file).Markup
	
output = new Markup(root).parse ->
##Marcup code here

Or you can execute from a given coffeescript file:

data.coffee:

#Marcup code here

And then run in terminal: coffee markup.coffee data.coffee #{path_to_output_file}

##The Language

There are two ways to run each command. The first is inline and the second is as a block. To produce inline html you execute commands like:

p "This is a paragraph"

Which will produce:

<p>This is a paragraph</p>

On the other hand, to produce a block, you would use the same command but as a block in coffee script:

p ->
	text "This is a paragraph""

Which will produce:

<p>
	This is a paragraph
</p>

##Adding Attributes

To add attributes to a tag in Marcup, you simply pass objects to a block.

To do this inline do:

div class: "A class", style: "The style", "This goes in the div"

Which will return:

<div class="A class" style="The style">This goes in the div</div>

To do this as a block you would:

div class: "Class", ->
	text "Inside the div"

Note that the last comma is important, so don't leave this out!

This will produce:

<div class="class">
	Inside the div
</div>

##Marcup Unique Syntax

###Links

To do links in Marcup you use the link tag and pass it a to attribute:

link to: "http://google.com", "Google"

Or as a block:

link to:"http://google.com", ->
	text "Google"

Which produces:

<a href="http://google.com">Google</a>

Or:

<a href="http://google.com">
	Google
</a>

respectively.

###Lists

To create lists in Marcup you use the list tag and pass it a type attribute with either "ordered" or "unordered" as the value. This will specify weather the list should be ordered or not and will default to unordered if no value is given. Additionally, each list item is distinguished by an item tag. This will look something like:

list type: "unordered", class: "Class", ->
	item "Item 1"
	for i in [2..10]
		item "Item #{i}"

Which will produce:

<ul class="Class">
 <li>Item 1</li>
 <li>Item 2</li>
 <li>Item 3</li>
 <li>Item 4</li>
 <li>Item 5</li>
 <li>Item 6</li>
 <li>Item 7</li>
 <li>Item 8</li>
 <li>Item 9</li>
 <li>Item 10</li>
</ul>

Current Tags

  • 0.0.3                                ...           latest (7 years ago)

3 Versions

  • 0.0.3                                ...           7 years ago
  • 0.0.2                                ...           7 years ago
  • 0.0.1                                ...           7 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 1
Last Month 1
Dependencies (1)
Dev Dependencies (0)
None
Dependents (1)

Copyright 2014 - 2016 © taobao.org |