https://github.com/tani/asciidoctor-wasm
https://github.com/tani/asciidoctor-wasm
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tani/asciidoctor-wasm
- Owner: tani
- License: mit
- Created: 2024-06-13T06:56:46.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-29T08:32:18.000Z (11 months ago)
- Last Synced: 2025-04-15T19:09:13.743Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://tani.github.io/asciidoctor-wasm/
- Size: 138 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Asciidoctor WASM
## Overview
This module provides an interface for converting Asciidoctor content to various formats using WebAssembly.
It supports conversion to `html5`, `docbook5`, and `manpage` backends, and allows for customization through various options.
The conversion is powered by Ruby's Asciidoctor library running in a WebAssembly (WASM) environment.
## Playground
You can try out the Asciidoctor WASM in the [Playground](https://tani.github.io/asciidoctor-wasm/).
## Installation
Ensure you have Node.js installed, then install the necessary dependencies:
https://jsr.io/@gem/asciidoctor-wasm
## Usage
### Importing the Module
You can import the necessary functions and constants from the module:
```typescript
import { Asciidoctor, wasmURL } from "@gem/asciidoctor-wasm/browser";
import { Asciidoctor, wasmURL } from "@gem/asciidoctor-wasm/deno";
import { Asciidoctor, wasmURL } from "@gem/asciidoctor-wasm/node";
```
### Initializing the Converter
#### From a WebAssembly Module
To initialize the Asciidoctor converter from a WebAssembly module:
```typescript
const wasmURL = import.meta.resolve('@gem/asciidoctor-wasm/asciidoctor.wasm.gz');
const response = await fetch(url);
const decpressionStream = new DecompressionStream('gzip');
const decompressedResponse = new Response(response.body!.pipeThrough(decpressionStream));
decompressedResponse.headers.set('content-type', 'application/wasm');
const module = await WebAssembly.compileStreaming(decompressedResponse);
const asciidoctor = await Asciidoctor.initFromModule(module);
```
#### From a WebAssembly URL
To initialize the Asciidoctor converter from a WebAssembly binary located at a URL:
```typescript
const wasmURL = import.meta.resolve('@gem/asciidoctor-wasm/asciidoctor.wasm.gz');
const asciidoctor = await Asciidoctor.initFromURL(wasmURL);
```
#### From a WebAssembly Path
To initialize the Asciidoctor converter from a WebAssembly binary located at a path:
```typescript
import {fileURLToPath} from 'node:url';
const wasmURL = import.meta.resolve('@gem/asciidoctor-wasm/asciidoctor.wasm.gz');
const wasmPath = fileURLToPath(wasmURL);
const asciidoctor = await Asciidoctor.initFromPath(wasmPath);
```
### Converting Asciidoctor Content
Once the converter is initialized, you can use it to convert Asciidoctor content:
```typescript
const asciidoctorContent = "= Asciidoctor\nDoc Writer\n\nHello, Asciidoctor!";
const options: AsciidoctorOptions = {
backend: "html5",
doctype: "article",
standalone: true,
};
const convertedContent = await asciidoctor.convert(asciidoctorContent, options);
console.log(convertedContent);
```
## Development
1. `deno task ruby:install`: Install dependencies for building Ruby.
2. `deno task ruby:build`: Build Ruby.
3. `deno task test`: Run the tests.
4. `deno task benchmark`: Run the benchmark.
## Versioning
This module follows the versioning of the Asciidoctor library it is based on.
- `0..`
- ``: Asciidoctor version; e.g., `2023` is based on Asciidoctor 2.0.23.
- ``: Asciidoctor WebAssembly module version.
## License
WASM binary contains a copy of several OSSs as follows:
- Ruby: https://www.ruby-lang.org/en/about/license.txt
- libyaml: https://github.com/yaml/libyaml/blob/840b65c40675e2d06bf40405ad3f12dec7f35923/License
- zlib: https://github.com/madler/zlib/blob/0f51fb4933fc9ce18199cb2554dacea8033e7fd3/LICENSE
- OpenSSL: https://www.openssl.org/source/license.html
- Asciidoctor: https://github.com/asciidoctor/asciidoctor/blob/e070613f0932b18cfb64370a8f0b6a0831eee4cd/LICENSE
- rouge: https://github.com/rouge-ruby/rouge/blob/c150ef96045f0c054d0d28f37a5228cb3779fc7d/LICENSE
- ruby.wasm: https://github.com/ruby/ruby.wasm/blob/fac40c1b7ffcb65b8c25e3c7c719fd1eac885e47/LICENSE
- wasi-vfs: https://github.com/kateinoigakukun/wasi-vfs/blob/ad74438287035ea01f3ce895e495740f7981215c/LICENSE
- @bjorn3/browser_wasi_shim: https://github.com/bjorn3/browser_wasi_shim/blob/377fbebf89dc95ba2375b69d3ffbb5b39632b834/LICENSE-MIT
If you notice the missing license information, please let us know.
This project is licensed under the MIT License. See the `LICENSE` file for details.