mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-12-23 08:47:50 +00:00

History

Hong Jiarong 8a28ff4afc Some checks are pending tinymist::auto_tag / auto-tag (push) Waiting to run Details tinymist::ci / Duplicate Actions Detection (push) Waiting to run Details tinymist::ci / Check Clippy, Formatting, Completion, Documentation, and Tests (Linux) (push) Waiting to run Details tinymist::ci / Check Minimum Rust version and Tests (Windows) (push) Waiting to run Details tinymist::ci / prepare-build (push) Waiting to run Details tinymist::ci / announce (push) Blocked by required conditions Details tinymist::ci / build (push) Blocked by required conditions Details tinymist::gh_pages / build-gh-pages (push) Waiting to run Details chore: switch cmark-writer dependency to local path (#2171 ) Further fix and refactor may base on this pr. also refactor: centralize CommonMark spacing and fix inline custom node handling - add `FormatPolicy` to manage trailing newline / blank-line rules and expose prepare_block_sequence - route document, blockquote, and list content through the policy so nested blocks get consistent spacing - adjust `Node::is_block` / `is_inline` to respect `CustomNode::is_block`, preventing inline custom nodes from forcing HTML fallbacks - ensure table rendering stays in Markdown by recognizing inline custom cells correctly --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>		2025-10-12 15:50:19 +08:00
..
src	chore: switch cmark-writer dependency to local path (#2171 )	2025-10-12 15:50:19 +08:00
Cargo.toml	docs: document all public items in rust codebase (#2058 )	2025-08-21 12:50:03 +08:00
dist.toml	build: enable typlite distribution in dist.toml (#1810 )	2025-06-12 18:05:37 +08:00
README.md	build: update readme docs (#2114 )	2025-09-12 00:50:56 +08:00

README.md

Typlite

Converts a subset of typst to markdown.

Installation

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Myriad-Dreamin/tinymist/releases/download/v0.13.26-rc1/typlite-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -ExecutionPolicy Bypass -c "irm https://github.com/Myriad-Dreamin/tinymist/releases/download/v0.13.26-rc1/typlite-installer.ps1 | iex"

Usage

# default output is main.md
typlite main.typ
# specify output
typlite main.typ output.md

Supported format:

output.txt: Plain text
output.md: Markdown
output.tex: LaTeX
output.docx: Word

Todo: We may support custom format by typst scripting in future, like:

# specify output
typlite main.typ --post-process @preview/typlite-mdx output.mdx

Feature

Contexual Content Rendering: Contents begin with context keyword will be rendered as svg output. The svg output will be embedded inline in the output file as base64 by default, if the --assets-path parameter is not specified. Otherwise, the svg output will be saved in the specified folder and the path will be embedded in the output file.

Typlite-Specific `sys.inputs`

The sys.input.x-target can be used distinguish with normal HTML export.

#let x-target = sys.inputs.at("x-target", default: "pdf")

#let my-function = if x-target == "md" {
  md-impl
} else {
  pdf-impl or html-impl
}