Current section
Files
Jump to
Current section
Files
README.md
# marksy
[](https://hex.pm/packages/marksy)
[](https://marksy.hexdocs.pm/)
[](https://github.com/peregrinefinch/marksy/actions/workflows/test.yml)
Markdown, HTML, and TOML front matter for Pooka. Metadata uses `---` delimiters.
## Installation
```sh
pooka add marksy
```
## Usage
```pooka
module main
import marksy
main() {
echo marksy.to_html("# Owl\n\nA *small* visitor.\n")
}
```
All 652 official CommonMark 0.31.2 examples pass. Tables, task lists, and
strikethrough are opt-in; their 13 official GFM examples pass too. Use the
[guide](docs/guide.md) for metadata, typed ASTs, extensions, HTML policies, and
resource-bounded parsing. [Conformance](docs/conformance.md) records the scope.
## Licence
[Apache-2.0](LICENSE). Entity data and specification fixtures retain their
original licences; see [third-party notices](docs/licences.md).