1
0
Fork 0
mirror of https://github.com/Oreolek/raconteur.git synced 2024-05-17 00:08:16 +03:00
Go to file
2015-04-10 19:29:27 -03:00
devel Complete switch to npm for dependency management 2015-04-10 19:29:27 -03:00
lib Complete switch to npm for dependency management 2015-04-10 19:29:27 -03:00
node_modules Add symlink to /lib 2015-04-10 18:24:31 -03:00
.gitignore Add package.json, set up for npm 2015-04-10 18:18:44 -03:00
init.js hacking 2015-04-07 17:49:35 -03:00
LICENSE add LICENSE 2015-04-07 21:56:20 -03:00
package.json Complete switch to npm for dependency management 2015-04-10 19:29:27 -03:00
README.md add LICENSE 2015-04-07 21:55:53 -03:00
undularity.sublime-project Complete switch to npm for dependency management 2015-04-10 19:29:27 -03:00

Undularity

Undularity is a wrapper library for Undum which provides a lot of commonly-used functionality inspired by common Twine extensions, such as replacer/inserter links. It also provides a new API for Undum, with a DSL-like syntax that is especially suitable to be used with CoffeeScript or ES6.

Undularity is still a work in progress.

Code example

Defining a situation in Undularity using ES6:

situation('undularity_example', {
  content: `
  This is an example situation using Undularity's API. It supports Markdown
  in text, and helper functions to add 
  ${a().class('segue').content('links').toSituation('another_situation')}
  more easily.
  `});

Or with CoffeeScript:

situation 'undularity_example',
  content: """
  This is an example of a situation using Undularity's API. It supports Markdown
  in text, and helper functions to add
  #{a().class('segue').content('links').toSituation('another_situation')}
  more easily.
  """
# The link will render as:
# <a class="segue" href="another_situation">links</a>

License

In short: You can use, modify, or redistribute Undularity and Undum, for any purpose, as long as this license document is kept with copies of it. See LICENSE for legalese.

Undum is copyright (c) 2009-2015 I D Millington, and released under the MIT license.

Undularity itself is copyright (c) 2015 Bruno Dias, and released under the same MIT license.