Skip to content
Very Ornate Code -- A Literate Programming Framework for JS and compile-to-JS languages.
JavaScript
Find file
Failed to load latest commit information.
.gitignore Initial commit
.npmignore Initial commit
LICENSE version bump 0.5.0: streamlined node module
Makefile Initial commit
README.md Initial commit
marked.js
mkdirp.js
package.json version bump 0.5.0: streamlined node module
scriptify.js.md Initial commit
voc.js version bump 0.5.0: streamlined node module
voc.md version bump 0.5.0: streamlined node module
voc.njs Initial commit

README.md

Very Ornate Code

So Literate Coffeescript is a cool idea, but why isn't there a standard JS or compile-to-JS version? JS Programmers want some love too! This is my effort to rectify this inequity.

How to use this

To use in-browser, include the marked source (and optionally the coffee-script source if desired):

<script src="https://raw.github.com/chjj/marked/master/lib/marked.js"></script>
<script src="http://coffeescript.org/extras/coffee-script.js"></script>

In tooling, npm install -g voc and run against your markdown file:

$ voc yourfile.md

VOC style

VOC searches for markdown code blocks. Using GFM guards (triple backticks), hints after the opening backticks are used to direct content.

For example, "```>foo.bar" will redirect content in the codeblock to foo.bar.

Preprocessing

If a preprocessor is available, VOC can be told to use it! This is needed for certain magic cases like Makefiles (which require explicit tabs).

As described in voc.md, there are two exported methods: add and run. To add your own language preprocessor:

  1. Define the handler function (accepts code and returns JS)

  2. Add the language to the framework

  3. Profit!

See the enclosed voc.md for more information.

Something went wrong with that request. Please try again.