omd2tex.objects.document module

class omd2tex.objects.document.Document(filename: str = '', settings: Dict[str, Any] | str = None, preamble: str = None)

Bases: BaseClass

from_file(filename: str) → Document

Load and parse a markdown file into a Document.

from_text(text: str) → Document

Create a document from raw markdown text.

from_elements(list: list) → Document

Build a document from preconstructed elements.

check() → None

Print contained file diagnostics and reset global state.

to_latex() → str

Render the document to a full LaTeX string with preamble and body.

to_latex_file(filename: str = '') → None

Write the rendered LaTeX document to a file.

Parameters:

filename – Optional override for output filename; defaults to derived from markdown name.

Returns:

None

Side Effects:

Writes LaTeX files to disk and may create makefiles.

to_latex_project(filename='') → None

Create a full LaTeX project directory with includes and assets.

Parameters:

filename – Optional override for main filename.

Returns:

None

Raises:

ValueError – If the document or file is not initialized before export.

Side Effects:

Writes multiple files/directories and copies theme assets when needed.