npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

marcup

v0.0.03

Published

A simple markup language that allows you to write a modified form of HTML in CoffeeScript.

Downloads

3

Readme

#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>