On this page
MoonBit API API Summary Review Notes Symbol Index Functions Structs Enums Functions api_reference_theme blocks_to_toc build_index_page build_output_manifest_json build_quality_report_json build_robots_txt build_search_index build_site_manifest build_site_manifest_with_options build_site_manifest_with_theme build_site_report build_sitemap collect_search_entries default_site_options default_theme diagnostics_to_text empty_front_matter evaluate_quality extract_headings extract_toc has_validation_errors html_escape inspect_manifest mbti_to_page measure_blocks measure_document measure_site package_theme parse_blocks parse_document parse_mbti plan_routes render_blocks render_markdown render_page render_page_with_options render_page_with_theme render_site render_site_with_options render_site_with_theme slugify summarize_site validate_site Structs AnchoredHeading ApiReference ApiSymbol BuildReport DocPage DocSite DocumentMetrics FrontMatter OutputFile OutputFileInfo ParsedDocument QualityCheck QualityGate RenderedPage RouteEntry SearchEntry SiteDiagnostic SiteMetrics SiteOptions SiteSummary SiteTheme TocItem ValidationReport Enums DiagnosticLevel MarkdownBlock

MoonBit API

Package Estrella-11/moondockit exposes 68 public declarations.

API Summary

Review Notes

Symbol Index

Functions

Structs

Enums

Functions

api_reference_theme

pub fn api_reference_theme() -> SiteTheme

blocks_to_toc

pub fn blocks_to_toc(Array[MarkdownBlock]) -> Array[TocItem]

build_index_page

pub fn build_index_page(DocSite) -> String?

build_output_manifest_json

pub fn build_output_manifest_json(Array[OutputFile]) -> String

build_quality_report_json

pub fn build_quality_report_json(DocSite) -> String

build_robots_txt

pub fn build_robots_txt() -> String

build_search_index

pub fn build_search_index(DocSite) -> String

build_site_manifest

pub fn build_site_manifest(DocSite) -> Array[OutputFile]

build_site_manifest_with_options

pub fn build_site_manifest_with_options(DocSite, SiteTheme, SiteOptions) -> Array[OutputFile]

build_site_manifest_with_theme

pub fn build_site_manifest_with_theme(DocSite, SiteTheme) -> Array[OutputFile]

build_site_report

pub fn build_site_report(DocSite) -> BuildReport

build_sitemap

pub fn build_sitemap(DocSite) -> String

collect_search_entries

pub fn collect_search_entries(DocSite) -> Array[SearchEntry]

default_site_options

pub fn default_site_options() -> SiteOptions

default_theme

pub fn default_theme() -> SiteTheme

diagnostics_to_text

pub fn diagnostics_to_text(ValidationReport) -> String

empty_front_matter

pub fn empty_front_matter() -> FrontMatter

evaluate_quality

pub fn evaluate_quality(DocSite) -> QualityGate

extract_headings

pub fn extract_headings(Array[MarkdownBlock]) -> Array[AnchoredHeading]

extract_toc

pub fn extract_toc(String) -> Array[TocItem]

has_validation_errors

pub fn has_validation_errors(ValidationReport) -> Bool

html_escape

pub fn html_escape(String) -> String

inspect_manifest

pub fn inspect_manifest(Array[OutputFile]) -> BuildReport

mbti_to_page

pub fn mbti_to_page(String) -> DocPage

measure_blocks

pub fn measure_blocks(Array[MarkdownBlock]) -> DocumentMetrics

measure_document

pub fn measure_document(String) -> DocumentMetrics

measure_site

pub fn measure_site(DocSite) -> SiteMetrics

package_theme

pub fn package_theme() -> SiteTheme

parse_blocks

pub fn parse_blocks(String) -> Array[MarkdownBlock]

parse_document

pub fn parse_document(String) -> ParsedDocument

parse_mbti

pub fn parse_mbti(String) -> ApiReference

plan_routes

pub fn plan_routes(DocSite) -> Array[RouteEntry]

render_blocks

pub fn render_blocks(Array[MarkdownBlock]) -> String

render_markdown

pub fn render_markdown(String) -> String

render_page

pub fn render_page(DocSite, DocPage) -> RenderedPage

render_page_with_options

pub fn render_page_with_options(DocSite, DocPage, SiteTheme, SiteOptions) -> RenderedPage

render_page_with_theme

pub fn render_page_with_theme(DocSite, DocPage, SiteTheme) -> RenderedPage

render_site

pub fn render_site(DocSite) -> Array[RenderedPage]

render_site_with_options

pub fn render_site_with_options(DocSite, SiteTheme, SiteOptions) -> Array[RenderedPage]

render_site_with_theme

pub fn render_site_with_theme(DocSite, SiteTheme) -> Array[RenderedPage]

slugify

pub fn slugify(String) -> String

summarize_site

pub fn summarize_site(DocSite) -> SiteSummary

validate_site

pub fn validate_site(DocSite) -> ValidationReport

Structs

AnchoredHeading

pub(all) struct AnchoredHeading {
  level : Int
  title : String
  anchor : String
}

ApiReference

pub(all) struct ApiReference {
  package_name : String
  symbols : Array[ApiSymbol]
}

ApiSymbol

pub(all) struct ApiSymbol {
  kind : String
  name : String
  signature : String
  arity : Int
  return_type : String
}

BuildReport

pub(all) struct BuildReport {
  file_count : Int
  html_count : Int
  data_count : Int
  total_bytes : Int
  files : Array[OutputFileInfo]
}

DocPage

pub(all) struct DocPage {
  title : String
  slug : String
  source : String
}

DocSite

pub(all) struct DocSite {
  title : String
  pages : Array[DocPage]
}

DocumentMetrics

pub(all) struct DocumentMetrics {
  heading_count : Int
  paragraph_count : Int
  list_item_count : Int
  code_block_count : Int
  word_count : Int
  reading_minutes : Int
}

FrontMatter

pub(all) struct FrontMatter {
  title : String?
  order : Int?
  tags : Array[String]
  fields : Array[(String, String)]
}

OutputFile

pub(all) struct OutputFile {
  path : String
  content : String
}

OutputFileInfo

pub(all) struct OutputFileInfo {
  path : String
  kind : String
  byte_count : Int
}

ParsedDocument

pub(all) struct ParsedDocument {
  front_matter : FrontMatter
  blocks : Array[MarkdownBlock]
}

QualityCheck

pub(all) struct QualityCheck {
  name : String
  passed : Bool
  message : String
}

QualityGate

pub(all) struct QualityGate {
  passed : Bool
  score : Int
  checks : Array[QualityCheck]
}

RenderedPage

pub(all) struct RenderedPage {
  path : String
  html : String
}

RouteEntry

pub(all) struct RouteEntry {
  title : String
  slug : String
  path : String
  order : Int?
  tags : Array[String]
}

SearchEntry

pub(all) struct SearchEntry {
  title : String
  path : String
  text : String
  tags : Array[String]
}

SiteDiagnostic

pub(all) struct SiteDiagnostic {
  level : DiagnosticLevel
  code : String
  message : String
  page : String?
}

SiteMetrics

pub(all) struct SiteMetrics {
  page_count : Int
  heading_count : Int
  code_block_count : Int
  word_count : Int
  reading_minutes : Int
}

SiteOptions

pub(all) struct SiteOptions {
  language : String
  description : String
  site_url : String
  footer : String
}

SiteSummary

pub(all) struct SiteSummary {
  page_count : Int
  output_count : Int
  search_entry_count : Int
  tag_count : Int
}

SiteTheme

pub(all) struct SiteTheme {
  background : String
  surface : String
  text : String
  accent : String
  border : String
  code_background : String
  code_text : String
  sidebar_width_px : Int
  content_width_px : Int
}

TocItem

pub(all) struct TocItem {
  level : Int
  title : String
  anchor : String
}

ValidationReport

pub(all) struct ValidationReport {
  diagnostics : Array[SiteDiagnostic]
}

Enums

DiagnosticLevel

pub(all) enum DiagnosticLevel {
  DiagError
  DiagWarning
}

MarkdownBlock

pub(all) enum MarkdownBlock {
  Heading(Int, String)
  Paragraph(String)
  UnorderedList(Array[String])
  BlockQuote(String)
  CodeBlock(String, String)
}