snudown-js

snudown-js
=======


snudown-js is a 'native' (compiled with Emscripten) port of Snudown, the Markdown parser used by Reddit.

Usage
-----

Import from npm: const Snudown = require('snudown-js').

Basic usage:

Snudown.markdown('some text'); // "

some text

Snudown.markdownWiki('

For more in-depth documentation, see the comments in footer.js.

Building
--------

$3

- to be able to run bash scripts
- gperf, a command-line utility - through your package manager
- npm, node package manager - through your package manager
- emcc, the Emscripten compiler - from the Emscripten SDK (or from source) (at least version 1.36.0)

$3

Run npm i.

Ensure that gperf and emcc can be invoked from the terminal.

$3

Run ./build.sh.

Output is to dist/.

Testing
-------

$3

- node, the node.js runtime - probably installed during the build process
- a successful build of snudown-js

After building, run node test_snudown.js.

License
-------

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.