MoonBit API

Package Estrella-11/moondockit exposes 78 public declarations.

API Summary

Functions: 47
Structs: 25
Enums: 6

Review Notes

Source: generated .mbti package interface from moon info.
Navigation: symbol index links point to each generated declaration.
Function entries include parameter counts and return types when available.

Symbol Index

Functions

api_reference_theme

Parameters: 0
Returns: SiteTheme

pub fn api_reference_theme() -> SiteTheme

blocks_to_toc

Parameters: 1
Returns: Array[TocItem]

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

build_index_page

Parameters: 1
Returns: String?

pub fn build_index_page(DocSite) -> String?

build_output_manifest_json

Parameters: 1
Returns: String

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

build_quality_report_json

Parameters: 1
Returns: String

pub fn build_quality_report_json(DocSite) -> String

build_robots_txt

Parameters: 0
Returns: String

pub fn build_robots_txt() -> String

build_search_index

Parameters: 1
Returns: String

pub fn build_search_index(DocSite) -> String

build_site_manifest

Parameters: 1
Returns: Array[OutputFile]

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

build_site_manifest_with_options

Parameters: 3
Returns: Array[OutputFile]

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

build_site_manifest_with_theme

Parameters: 2
Returns: Array[OutputFile]

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

build_site_report

Parameters: 1
Returns: BuildReport

pub fn build_site_report(DocSite) -> BuildReport

build_sitemap

Parameters: 1
Returns: String

pub fn build_sitemap(DocSite) -> String

collect_search_entries

Parameters: 1
Returns: Array[SearchEntry]

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

count_doc_examples

Parameters: 1
Returns: Int

pub fn count_doc_examples(String) -> Int

default_site_options

Parameters: 0
Returns: SiteOptions

pub fn default_site_options() -> SiteOptions

default_theme

Parameters: 0
Returns: SiteTheme

pub fn default_theme() -> SiteTheme

diagnostics_to_text

Parameters: 1
Returns: String

pub fn diagnostics_to_text(ValidationReport) -> String

empty_front_matter

Parameters: 0
Returns: FrontMatter

pub fn empty_front_matter() -> FrontMatter

evaluate_quality

Parameters: 1
Returns: QualityGate

pub fn evaluate_quality(DocSite) -> QualityGate

extract_doc_examples

Parameters: 1
Returns: Array[DocExample]

pub fn extract_doc_examples(String) -> Array[DocExample]

extract_headings

Parameters: 1
Returns: Array[AnchoredHeading]

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

extract_toc

Parameters: 1
Returns: Array[TocItem]

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

has_validation_errors

Parameters: 1
Returns: Bool

pub fn has_validation_errors(ValidationReport) -> Bool

html_escape

Parameters: 1
Returns: String

pub fn html_escape(String) -> String

inspect_manifest

Parameters: 1
Returns: BuildReport

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

is_runnable_moonbit_example

Parameters: 1
Returns: Bool

pub fn is_runnable_moonbit_example(String) -> Bool

mbti_to_page

Parameters: 1
Returns: DocPage

pub fn mbti_to_page(String) -> DocPage

measure_blocks

Parameters: 1
Returns: DocumentMetrics

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

measure_document

Parameters: 1
Returns: DocumentMetrics

pub fn measure_document(String) -> DocumentMetrics

measure_site

Parameters: 1
Returns: SiteMetrics

pub fn measure_site(DocSite) -> SiteMetrics

package_theme

Parameters: 0
Returns: SiteTheme

pub fn package_theme() -> SiteTheme

parse_blocks

Parameters: 1
Returns: Array[MarkdownBlock]

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

parse_document

Parameters: 1
Returns: ParsedDocument

pub fn parse_document(String) -> ParsedDocument

parse_mbti

Parameters: 1
Returns: ApiReference

pub fn parse_mbti(String) -> ApiReference

plan_routes

Parameters: 1
Returns: Array[RouteEntry]

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

render_blocks

Parameters: 1
Returns: String

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

render_doc_test_file

Parameters: 2
Returns: String

pub fn render_doc_test_file(Array[DocExample], String) -> String

render_markdown

Parameters: 1
Returns: String

pub fn render_markdown(String) -> String

render_page

Parameters: 2
Returns: RenderedPage

pub fn render_page(DocSite, DocPage) -> RenderedPage

render_page_with_options

Parameters: 4
Returns: RenderedPage

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

render_page_with_theme

Parameters: 3
Returns: RenderedPage

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

render_site

Parameters: 1
Returns: Array[RenderedPage]

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

render_site_with_options

Parameters: 3
Returns: Array[RenderedPage]

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

render_site_with_theme

Parameters: 2
Returns: Array[RenderedPage]

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

slugify

Parameters: 1
Returns: String

pub fn slugify(String) -> String

summarize_site

Parameters: 1
Returns: SiteSummary

pub fn summarize_site(DocSite) -> SiteSummary

validate_site

Parameters: 1
Returns: ValidationReport

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]
}

DocExample

pub(all) struct DocExample {
  index : Int
  code : String
}

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)]
}

I18n

pub(all) struct I18n {
  search_label : String
  search_placeholder : String
  theme_toggle : String
  skip_link : String
  toc_title : String
  no_results : String
  lang_toggle : 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
}

ListBlock

pub(all) enum ListBlock {
  ListBlock(ListKind, Array[ListItem])
}

ListItem

pub(all) enum ListItem {
  ListItem(String, Bool?, ListBlock?)
}

ListKind

pub(all) enum ListKind {
  Bullet
  Number
}

MarkdownBlock

pub(all) enum MarkdownBlock {
  Heading(Int, String)
  Paragraph(String)
  List(ListBlock)
  BlockQuote(String)
  CodeBlock(String, String)
  Table(Array[String], Array[TableAlign], Array[Array[String]])
}

TableAlign

pub(all) enum TableAlign {
  AlignDefault
  AlignLeft
  AlignCenter
  AlignRight
}

Built with MoonDocKit