From b53f5e086c3fa41083a3a17d73ffa3e8d4fa3872 Mon Sep 17 00:00:00 2001 From: Anhgelus Morhtuuzh Date: Sat, 25 Apr 2026 17:42:07 +0200 Subject: docs(info): bindings in readme --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5c8ea08..84d47e2 100644 --- a/README.md +++ b/README.md @@ -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. -- cgit v1.2.3