Skip to main content

Crate cellix_doc

Crate cellix_doc 

Source
Expand description

Documents: what makes a page more than text. Nothing here knows about the screen.

Modules§

changes
Suggested edits kept in the text itself, so they survive any tool and travel with the file. Markdown uses CriticMarkup and a paper uses the changes package.
diagram
Diagrams written as text, drawn by pure Rust so a page needs no browser or Node. Each kind comes out as SVG, which a web page keeps and a page in the editor turns into pixels.
fence
Fenced code blocks as CommonMark reads them: a block opened by three or more backticks or tildes is closed only by a run of the same character at least as long, with nothing after it. So a fence of four can hold a line of three, as a transcript’s tool output does.
figure
Pictures as a document’s source writes them, so the page, the web page and the PDF all read a picture’s size the same way. Markdown has no way to say how wide an image is, so this uses the form Pandoc and many others read: ![alt](path){width=50%}.
front
YAML front matter at the top of a Markdown document. Exports set it as the title, author and date, where it would otherwise print as a heading full of key: value lines.
html
A Markdown file as a web page that stands alone: math is inline SVG, so the page needs no scripts and no network.
latex
What a paper needs that isn’t on the page: which file to build, what to build it with, what went wrong and where, and Markdown turned into LaTeX for export.
math
Typeset math, from pure Rust and fonts in the binary, so it works over SSH on a server with no TeX. A formula that won’t parse is an error here and its source on the page.
notebook
A Jupyter notebook as a page. Its cells become Markdown that edits like any other page, with a hidden line above each saying which cell it is, and saving puts the text back into the JSON beside the outputs it already had. Cells don’t run here: that’s the kernel’s work, and a shell in the side pane can do it.
paper
A LaTeX paper split over files, read as LaTeX reads it: each \input and \include followed from the root’s folder, and a root found only if it really takes a file in.
pdf
A PDF’s pages as pixels, from pure Rust, so a paper shows beside its source on any host.
prose
Spelling and grammar for writing. Harper checks plain English, so what isn’t prose is blanked out first, keeping every other char where it was, and what it finds still lands on the right words in the source.
synctex
SyncTeX: how a PDF’s pages map back to the source lines that made them, and forward again. The engine writes the map when asked, and this reads it.
table
Editing a Markdown table as a table. Every change rewrites it with its columns lined up, so the source stays as readable as the page.
words
Counting a document’s words as a reader would: the prose, without markup, code or math.