https://github.com/foxfriends/outline-js
WebAssembly bindings for Outline (Literate programming tool)
https://github.com/foxfriends/outline-js
literate literate-programming
Last synced: 3 months ago
JSON representation
WebAssembly bindings for Outline (Literate programming tool)
- Host: GitHub
- URL: https://github.com/foxfriends/outline-js
- Owner: foxfriends
- Created: 2018-12-17T05:02:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T15:27:00.000Z (about 2 years ago)
- Last Synced: 2025-01-20T19:13:27.068Z (4 months ago)
- Topics: literate, literate-programming
- Language: Rust
- Size: 4.08 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[Outline]: https://github.com/foxfriends/outline
# Outline JS
This package provides WebAssembly bindings to the Rust library [Outline][].
In particular, it exposes the built in parsers for use in a JavaScript context. For documentation on
anything not specific to the WASM bindings, see the main [Outline][] repo.
## Installation
```bash
npm install --save @oinkiguana/outline
```
## Example Usage
```js
import { MdParser } from '@oinkiguana/outline';
const parser = new MdParser().set_fence_sequence('~~~');
const helloWorld = parser.tangle(`
# Hello world
Here we have the hello world:
~~~
==> Say hello.
~~~
This is how you say hello:
~~~ - Say hello
console.log('Hello world');
~~~
`);
eval(helloWorld); // should log 'Hello world'
```
## Documentation
The package exports just the 4 parsers:
* `MdParser`
* `HtmlParser`
* `TexParser`
* `BirdParser`
Each follows a very similar API:
`parser.tangle(source[, entrypoint[, language]])`
* Parses the `source` to produce the tangled (runnable code) output
* `entrypoint` and `language` are passed along to Outline, and used to choose the entrypoint and
language to compile
* If there is an error, it will be thrown (as a string)
`parser.weave(source)`
* Parses the `source` to produce the weaved documentation output
* If there is an error, it will be thrown (as a string)
`parser.set_(value)`
* Sets the config property on the parser. See the [Outline][] documentation for information on the
options for each parser
* Mutates and returns `this` for chaining
`parser.()`
* Retrieves the current value of the property