diff options
| author | Anhgelus Morhtuuzh <william@herges.fr> | 2026-04-25 17:42:07 +0200 |
|---|---|---|
| committer | Anhgelus Morhtuuzh <william@herges.fr> | 2026-04-25 17:42:07 +0200 |
| commit | b53f5e086c3fa41083a3a17d73ffa3e8d4fa3872 (patch) | |
| tree | cfe2bd5bfd3e7665e8d84227d5809b9471cbad69 /README.md | |
| parent | c008d747534f4c8aa59b045efbca754618e14b41 (diff) | |
docs(info): bindings in readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 24 insertions, 1 deletions
@@ -1,3 +1,26 @@ # typdown -typdown is a markup language that looks like markdown, but with a better syntax. +typdown is a markup language that looks like Markdown, but with a better syntax. + +It can be compiled into HTML, Markdown (CommonMark), typst or PDF. + +## Bindings + +typdown is written in Zig, but you can choose almost any languages to work with typdown files. + +Of course, you can use typdown with Zig: +```zig +// build.zig +const typdown = b.dependency("typdown", .{ + .optimize = optimize, + .target = target, +}).module("typdown"); +exe.root_module.addImport("typdown", typdown); +``` + +Zig can easily interop with C. +See `examples/main.c` for an example. + +And you can integrate the C ABI in almost any languages! +Example bindings for Go are in `go/`. +There is a `build.zig` to illustrate how to create one for your project. |
