The Official TapirMD Libraries

• The Zig library
• The WASM library
• The JavaScript library
• The Go library

The Zig library

...
        .tmd = .{
            .url = "https://github.com/tapirmd/tmd/archive/refs/tags/v0.0.5.zip",
        },
...

...
    const tmdModule = b.dependency("tmd", .{
		.target = target,
		.optimize = optimize,
	}).module("tmd");
...
    myModule.addImport("tmd", tmdModule);
...

The WASM library

1. Install Zig, if haven't. The latest version tip (master) version is recommended.

2. Get the source code of the TapirMD project. You can clone it (install Git if needed) or download its source code.

3. Open your terminal or command prompt, and change directory to the TapirMD project folder, then run

      zig build -Doptimize=ReleaseSmall wasm
   

   If the build is successful, the output tmd.wasm binary file will be located in the lib folder under the project local zig-out folder.

• lib_version returns the memory offset of the version string of the library. The version string is C-style string which ends with 0.
• buffer_offset returns the memory offset of the buffer for communicating between WASM and host apps. The input TapirMD document content with a length header should be placed at the beginning of the buffer.
• tmd_parse parses the input TapirMD document and returns the memory offset of unused buffer (for communicating between WASM and host apps). The following APIs should put their options data at the returned memory offset.
• tmd_title generates the title (without any formatting elements) of the input TapirMD document and returns the memory offset of the title with a length header. If the title length is 0xFFFFFFFF, it means the input TapirMD document doesn't define a title.
• tmd_to_html generates HTML content from the input TapirMD document content and returns the memory offset of the output HTML content with a length header.
• tmd_format formats the input TapirMD document and returns the memory offset of the output formatted result with a length header. If the result length is 0xFFFFFFFF, it means the formatted result is identical to the input TapirMD document.

1. the 1st uint32 parameter means the memory offset of the first string.
2. the 2nd uint32 parameter means the length (in bytes) of the first string.
3. the 3rd uint32 parameter means the memory offset of the second string.
4. the 4th uint32 parameter means the length (in bytes) of the second string.
5. the final int32 parameter is just a plain integer value.

The JavaScript library

1. Install Zig, if haven't. The latest version tip (master) version is recommended.

2. Get the source code of the TapirMD project. You can clone it (install Git if needed) or download its source code.

3. Open your terminal or command prompt, and change directory to the TapirMD project folder, then run

      zig build -Doptimize=ReleaseSmall js
   

   If the build is successful, the output tmd-with-wasm.js file will be located in the lib folder under the project local zig-out folder.

The Go library