markdown

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 28, 2026 License: MIT Imports: 32 Imported by: 0

Documentation

Overview

Package markdown is a placeholder for Obsite Markdown processing.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewParser

func NewParser(_ *diag.Collector) goldmark.Markdown

NewParser returns the shared AST-only goldmark instance used by pass 1.

func VisibleHeadingText

func VisibleHeadingText(heading *gast.Heading, source []byte) string

VisibleHeadingText returns the user-visible text of a parsed heading.

Types

type AssetSink

type AssetSink interface {
	Register(vaultRelPath string) string
}

AssetSink is the render-time dependency boundary for discovered assets. Implementations return the site-relative output path for the registered asset.

type RenderResult

type RenderResult struct {
	// contains filtered or unexported fields
}

RenderResult exposes the render-local note state produced during pass 2.

func NewMarkdown

func NewMarkdown(idx *model.VaultIndex, note *model.Note, assetSink AssetSink, diagCollector *diag.Collector) (goldmark.Markdown, *RenderResult)

NewMarkdown returns a per-note goldmark instance plus its render-local result state.

func (*RenderResult) HasMath

func (r *RenderResult) HasMath() bool

HasMath reports whether the rendered page content contains math.

func (*RenderResult) HasMermaid

func (r *RenderResult) HasMermaid() bool

HasMermaid reports whether the rendered page content contains Mermaid blocks.

func (r *RenderResult) OutLinks() []model.LinkRef

OutLinks returns the render-local resolved outlinks for the source note.

Directories

Path Synopsis
Package callout is a placeholder for Obsite Markdown callouts.
Package callout is a placeholder for Obsite Markdown callouts.
Package comment is a placeholder for Obsite Markdown comment handling.
Package comment is a placeholder for Obsite Markdown comment handling.
Package embed renders Obsidian image and note embeds, rebasing section-scoped transclusions so recursive diagnostics stay anchored to the original note lines.
Package embed renders Obsidian image and note embeds, rebasing section-scoped transclusions so recursive diagnostics stay anchored to the original note lines.
Package highlight is a placeholder for Obsite syntax highlighting.
Package highlight is a placeholder for Obsite syntax highlighting.
Package math implements Obsidian-style LaTeX delimiter parsing for KaTeX auto-render output.
Package math implements Obsidian-style LaTeX delimiter parsing for KaTeX auto-render output.
Package wikilink resolves note-style Obsidian wikilinks against the pass-1 vault index.
Package wikilink resolves note-style Obsidian wikilinks against the pass-1 vault index.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL