Welcome to mirror list, hosted at ThFree Co, Russian Federation.

README.md - github.com/torch/sundown-ffi.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 44089f262e48693fe2f5fc4c504e615ca378d5c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
sundown-ffi
===========

A LuaJIT interface to the Sundown library (a Markdown implementation)

# Installation #

torch-rocks install https://raw.github.com/andresy/sundown-ffi/master/rocks/sundown-scm-1.rockspec

# Usage #

```lua
local sundown = require 'sundown'

local html = sundow.render[[
sundown-ffi
===========

A LuaJIT interface to the Sundown library (a Markdown implementation)

# Installation #

torch-rocks install https://raw.github.com/andresy/sundown-ffi/master/rocks/sundown-scm-1.rockspec
]]
```

# Advanced usage #

All functions from the library `sundown` and `houdini` are accessible through `sundown.C.func` where `func`
is the function of interest.

See the [Sundown library page](https://github.com/vmg/sundown) for more details.

Note that Houdini C function and structure names are prefixed here with `sdhtml_` (e.g. `sdhtml_renderer`).
Sundown C function and structure names are prefixed with `sd_` (e.g. `sd_markdown_render`).

See sdcdefs.lua and htmlcdefs.lua for what is actually available.