README
T
BroadcastMsg
T
BuildCache
T
ChangeType
T
Model
T
Msg
T
SiteConfig
T
Step
T
StructuredBlockInfo
V
build
V
double_to_string
V
escape_string
V
generate_main_mbt
V
indent_str
V
init_tui
V
scaffold
V
serialize_align
V
serialize_block
V
serialize_blocks
V
serialize_cell
V
serialize_document
V
serialize_emphasis
V
serialize_hardbreak
V
serialize_inline
V
serialize_inlines
V
serialize_list_item
V
serialize_md_inlines
V
serialize_span
V
serialize_string_map
V
serialize_value
V
serialize_value_map
V
serve

moonblox-cli

MoonBlox command-line tool

markdown

ssg

moonbit

site-generator

Download zip

Author

xz-xuezhe

Version

0.2.0

License

Apache-2.0

Repository

github.com/xz-xuezhe/moonblox

Last updated

3 months ago

Downloads

#MoonBlox CLI

Command-line tool for MoonBlox, a Markdown-first programmable site generator powered by MoonBit.

#Prerequisites

MoonBit toolchain (latest stable)
Moon's binary directory on your PATH:
```
export PATH="$HOME/.moon/bin:$PATH"
```

#Install

moon install xz-xuezhe/moonblox-cli

This installs the moonblox-cli binary globally.

#Quick Start

moonblox-cli init my-site
cd my-site
moonblox-cli serve

Open http://localhost:3000. Edit any Markdown file — the browser reloads automatically.

#Commands

#init — scaffold a new project

moonblox-cli init <dir> [options]

By default, init launches an interactive TUI that guides you through project setup (name, theme, components).

Options:

Flag	Description
--headless, -H	Skip interactive TUI (for CI / scripts)
--theme, -t <name>	Project theme: blog (default) or docs
--empty, -E	Skip generating sample content
--quiet, -q	Suppress non-essential output

Examples:

moonblox-cli init .                     # TUI in current directory
moonblox-cli init my-blog --headless    # scaffold in CI, blog theme
moonblox-cli init my-docs -t docs -H    # scaffold docs theme, no TUI
moonblox-cli init my-site -H -E         # empty scaffold, no sample content

The scaffolded project includes:

my-site/
  moonblox.json         → site configuration
  posts/                → Markdown content (blog theme)
  components/           → selected built-in components
  theme/base.css        → global styles
  _moonblox/            → generated MoonBit project (build target)

#build — build static site

moonblox-cli build [dir]

Parses Markdown, resolves components, and compiles to dist/ — a complete static site ready for deployment. Defaults to the current directory.

#serve — dev server with live reload

moonblox-cli serve [dir] [--port <port>]

Starts a development server at http://localhost:3000 with:

Live reload — changes to Markdown files trigger automatic rebuild and browser refresh via WebSocket.
Incremental builds — unchanged files are skipped, debug builds are used for faster iteration.

Options:

Flag	Description
--port, -p <port>	Server port (default: 3000)

#Project Configuration

Site settings live in moonblox.json at the project root:

{
  "input": "posts",
  "output": "dist",
  "components": "components",
  "theme": "blog"
}

#Documentation

Full docs: https://xz-xuezhe.github.io/moonblox/

#License

Apache 2.0

BroadcastMsg

source

pub(all) enum BroadcastMsg {
  Building
  Reload
  BuildFailed(String)
} derive(@moonbitlang/core/debug.Debug
Debug)

BuildCache

source

type BuildCache

ChangeType

source

type ChangeType

Model

source

type Model derive(@moonbitlang/core/debug.Debug
Debug)

Msg

source

type Msg derive(@moonbitlang/core/debug.Debug
Debug)

SiteConfig

source

type SiteConfig

Step

source

type Step derive(Eq, @moonbitlang/core/debug.Debug
Debug)

StructuredBlockInfo

source

type StructuredBlockInfo

build

source

async fn build(dir : String, dev_mode? : Bool) -> Bool

moonblox build — generate temp project in _moonblox/, compile, assemble output

double_to_string

source

fn double_to_string(n : Double) -> String

Serialize a double value as a MoonBit double literal. Ensures whole numbers get .0 suffix.

escape_string

source

fn escape_string(s : String) -> String

Escape a string for embedding in a MoonBit string literal. Handles \, ", \n, \t, \r.

generate_main_mbt

source

fn generate_main_mbt(doc : @xz-xuezhe/moonblox/ast.Document
Document) -> String

indent_str

source

fn indent_str(n : Int) -> String

Generate indentation string of 2*n spaces.

init_tui

source

async fn init_tui(default_dir? : String) -> String?

scaffold

source

fn scaffold(dir : String, theme? : String, components? : Array[String], quiet? : Bool, empty? : Bool) -> Result[Unit, String]

MoonBlox scaffold — moonblox-cli init <dir>

serialize_align

source

fn serialize_align(align : @mizchi/markdown.TableAlign
TableAlign) -> String

Serialize a TableAlign

serialize_block

source

fn serialize_block(block : @xz-xuezhe/moonblox/ast.Block
Block, indent : Int) -> String

Serialize a single Block with given indent.

serialize_blocks

source

fn serialize_blocks(blocks : Array[@xz-xuezhe/moonblox/ast.Block
Block], indent : Int) -> String

Serialize an array of @ast.Block with given indent.

serialize_cell

source

fn serialize_cell(cell : @xz-xuezhe/moonblox/ast.BlockTableCell
BlockTableCell, indent : Int) -> String

Serialize a BlockTableCell

serialize_document

source

fn serialize_document(doc : @xz-xuezhe/moonblox/ast.Document
Document) -> String

Serialize a Document to a MoonBit expression string. Returns code like: @ast.Document::{ children: [...], meta: Map([("title", "Hello")]) }

serialize_emphasis

source

fn serialize_emphasis(m : @mizchi/markdown.EmphasisMarker
EmphasisMarker) -> String

Serialize an EmphasisMarker

serialize_hardbreak

source

fn serialize_hardbreak(s : @mizchi/markdown.HardBreakStyle
HardBreakStyle) -> String

Serialize a HardBreakStyle

serialize_inline

source

fn serialize_inline(inline : @xz-xuezhe/moonblox/ast.Inline
Inline, indent : Int) -> String

Serialize @ast.Inline with given indent.

serialize_inlines

source

fn serialize_inlines(inlines : Array[@xz-xuezhe/moonblox/ast.Inline
Inline], indent : Int) -> String

Serialize an array of @ast.Inline with given indent.

serialize_list_item

source

fn serialize_list_item(item : @xz-xuezhe/moonblox/ast.ListItem
ListItem, indent : Int) -> String

Serialize a ListItem

serialize_md_inlines

source

fn serialize_md_inlines(inlines : Array[@mizchi/markdown.Inline
Inline], _indent : Int) -> String

Serialize an array of @markdown.Inline with given indent.

serialize_span

source

fn serialize_span(span : @mizchi/markdown.Span
Span) -> String

Serialize a Span

serialize_string_map

source

fn serialize_string_map(m : Map[String, String], _indent : Int) -> String

Serialize a Map[String, String] to a MoonBit expression.

serialize_value

source

fn serialize_value(v : @xz-xuezhe/moonblox/ast.Value
Value, indent : Int) -> String

Serialize a Value to a MoonBit expression.

serialize_value_map

source

fn serialize_value_map(m : Map[String, @xz-xuezhe/moonblox/ast.Value
Value], _indent : Int) -> String

Serialize a Map[String, Value] to a MoonBit expression.

serve

source

async fn serve(dir : String, port : Int) -> Unit

moonblox serve — dev server with file watching and live reload

Source Files

Site source Report issue Packages Build queue Skills Statistics

moonblox-cli

#MoonBlox CLI

#Prerequisites

#Install

#Quick Start

#Commands

#init — scaffold a new project

#build — build static site

#serve — dev server with live reload

#Project Configuration

#Documentation

#License

#BroadcastMsg

#BuildCache

#ChangeType

#Model

#Msg

#SiteConfig

#Step

#StructuredBlockInfo

#build

#double_to_string

#escape_string

#generate_main_mbt

#indent_str

#init_tui

#scaffold

#serialize_align

#serialize_block

#serialize_blocks

#serialize_cell

#serialize_document

#serialize_emphasis

#serialize_hardbreak

#serialize_inline

#serialize_inlines

#serialize_list_item

#serialize_md_inlines

#serialize_span

#serialize_string_map

#serialize_value

#serialize_value_map

#serve

Source Files

BroadcastMsg

BuildCache

ChangeType

Model

Msg

SiteConfig

Step

StructuredBlockInfo

build

double_to_string

escape_string

generate_main_mbt

indent_str

init_tui

scaffold

serialize_align

serialize_block

serialize_blocks

serialize_cell

serialize_document

serialize_emphasis

serialize_hardbreak

serialize_inline

serialize_inlines

serialize_list_item

serialize_md_inlines

serialize_span

serialize_string_map

serialize_value

serialize_value_map

serve