cosy

A parser for Cosense (formerly Scrapbox) markup syntax that produces a typed AST.

Installation

[dependencies]
cosy = "0.1"

To enable JSON serialization of the AST via serde:

[dependencies]
cosy = { version = "0.1", features = ["serde"] }

Usage

use cosy::ast::{BlockContent, Node};

let doc = cosy::parse("Hello [* world]! See [https://example.com].", &()).unwrap();

for block in &doc {
    if let BlockContent::Line(nodes) = &block.content {
        for node in nodes {
            println!("{node:?}");
        }
    }
}

Custom syntax extensions

Implement CosyParserExtension to inject your own bracket syntax:

use cosy::CosyParserExtension;

#[derive(Debug, PartialEq)]
enum MySyntax { Highlight(String) }

struct MyExt;
impl CosyParserExtension for MyExt {
    type Output = MySyntax;
    fn parse_bracket(&self, content: &str) -> Option<MySyntax> {
        content.strip_prefix("! ").map(|s| MySyntax::Highlight(s.to_string()))
    }
}

let doc = cosy::parse("[! important]", &MyExt).unwrap();

See examples/speech_bubble_extension.rs for a full example.

URL handling

Labeled links ([label https://...]) carry a parsed url::Url in Link::WithLabel.href. cosy re-exports the Url type at its crate root for convenience:

use cosy::Url;

Supported syntax

Block-level

Inline

License

MIT — see LICENSE.