Module

marksy/block

src/marksy/block.pooka

Settle the outline before reading the punctuation inside it. Fenced code and indented code keep literal contents; paragraphs alone ask the inline reader to interpret their words. The line reader retains original byte offsets even when CRLF becomes one logical newline.

Pooka
let document = block.parse("# Owl\n\nA visitor.\n")
assert list.length(document.blocks) == 2

API reference

class

Line

src/marksy/block.pooka:25
class Line(value: String, start: ast.Position, end: ast.Position, lazy: Bool)
field

value

src/marksy/block.pooka:25
value: String
INFERREDString
field

start

src/marksy/block.pooka:25
start: ast.Position
field

end

src/marksy/block.pooka:25
end: ast.Position
field

lazy

src/marksy/block.pooka:25
lazy: Bool
INFERREDBool
constructor

new

src/marksy/block.pooka:25
class

Marker

src/marksy/block.pooka:29
class Marker(
  ordered: Bool,
  start: Int,
  delimiter: String,
  indent: Int,
  content_column: Int,
  content: String
)
field

ordered

src/marksy/block.pooka:30
ordered: Bool
INFERREDBool
field

start

src/marksy/block.pooka:31
start: Int
INFERREDInt
field

delimiter

src/marksy/block.pooka:32
delimiter: String
INFERREDString
field

indent

src/marksy/block.pooka:33
indent: Int
INFERREDInt
field

content_column

src/marksy/block.pooka:34
content_column: Int
INFERREDInt
field

content

src/marksy/block.pooka:35
content: String
INFERREDString
constructor

new

src/marksy/block.pooka:30
INFERREDfn(Bool, Int, String, Int, Int, String) -> marksy/block.Marker
class

ItemRead

src/marksy/block.pooka:38
class ItemRead(
  lines: List(Line),
  rest: List(Line),
  last: Line,
  trailing_blank: Bool
)
field

lines

src/marksy/block.pooka:39
lines: List(Line)
INFERREDList(marksy/block.Line)
field

rest

src/marksy/block.pooka:40
rest: List(Line)
INFERREDList(marksy/block.Line)
field

last

src/marksy/block.pooka:41
last: Line
field

trailing_blank

src/marksy/block.pooka:42
trailing_blank: Bool
INFERREDBool
constructor

new

src/marksy/block.pooka:39
class

HtmlEnd

src/marksy/block.pooka:45
class HtmlEnd(closing: String, folded: Bool, blank: Bool)
field

closing

src/marksy/block.pooka:45
closing: String
INFERREDString
field

folded

src/marksy/block.pooka:45
folded: Bool
INFERREDBool
field

blank

src/marksy/block.pooka:45
blank: Bool
INFERREDBool
constructor

new

src/marksy/block.pooka:45
INFERREDfn(String, Bool, Bool) -> marksy/block.HtmlEnd
class

Fence

src/marksy/block.pooka:47
class Fence(marker: String, width: Int, indent: Int, info: String)
field

marker

src/marksy/block.pooka:47
marker: String
INFERREDString
field

width

src/marksy/block.pooka:47
width: Int
INFERREDInt
field

indent

src/marksy/block.pooka:47
indent: Int
INFERREDInt
field

info

src/marksy/block.pooka:47
info: String
INFERREDString
constructor

new

src/marksy/block.pooka:47
INFERREDfn(String, Int, Int, String) -> marksy/block.Fence
function

parse

src/marksy/block.pooka:51
parse(source: String) -> ast.Document
INFERREDfn(String) -> marksy/ast.Document

Read Markdown without stripping front matter. In ordinary Markdown, --- is a thematic break; metadata extraction belongs to the document API.

function

parse_at

src/marksy/block.pooka:56
parse_at(source: String, first_line: Int, first_byte: Int) -> ast.Document
INFERREDfn(String, Int, Int) -> marksy/ast.Document

Shift addresses when the body follows a metadata envelope.

function

parse_with

src/marksy/block.pooka:60
parse_with(source: String, options: syntax.Options) -> ast.Document
function

parse_at_with

src/marksy/block.pooka:64
parse_at_with(
  source: String,
  first_line: Int,
  first_byte: Int,
  options: syntax.Options
) -> ast.Document
INFERREDfn(String, Int, Int, marksy/syntax.Options) -> marksy/ast.Document