markupit package

Subpackages

• markupit.structure package
  • Submodules
  • markupit.structure.block module
    • BlockQuote
    • BulletList
    • CodeBlock
    • DefinitionList
    • Div
    • Figure
    • Header
    • HorizontalRule
    • LineBlock
    • Null
    • OrderedList
    • Para
    • Plain
    • RawBlock
    • Table
  • markupit.structure.content module
    • Attr
    • Caption
    • Cell
    • Citation
    • ColSpec
    • Format
    • ListAttributes
    • Row
    • TableBody
    • TableFoot
    • TableHead
    • Target
  • markupit.structure.document module
    • Document
      • Document.add_block()
      • Document.add_blocks()
      • Document.to_json()
  • markupit.structure.enum module
    • Alignment
    • CitationMode
    • ColWidth
    • ListNumberDelim
    • ListNumberStyle
    • MathType
    • QuoteType
  • markupit.structure.general_types module
    • Block
      • Block.to_json()
    • ContentElement
      • ContentElement.to_json()
    • Element
      • Element.to_json()
    • EnumElement
      • EnumElement.to_json()
    • Inline
      • Inline.to_json()
    • MetaValue
  • markupit.structure.inline module
    • Cite
    • Code
    • Emph
    • Image
    • LineBreak
    • Link
    • Math
    • Note
    • Quoted
    • RawInline
    • SmallCaps
    • SoftBreak
    • Space
    • Span
    • Str
    • Strikeout
    • Strong
    • Subscript
    • Superscript
    • Underline
  • Module contents
    • Document
      • Document.add_block()
      • Document.add_blocks()
      • Document.to_json()
• markupit.writers package
  • Submodules
  • markupit.writers.json_writer module
    • JsonWriter
      • JsonWriter.write()
      • JsonWriter.write_to_file()
  • markupit.writers.typst_writer module
    • TypstWriter
      • TypstWriter.convert_block_quote()
      • TypstWriter.convert_bullet_list()
      • TypstWriter.convert_code()
      • TypstWriter.convert_code_block()
      • TypstWriter.convert_emph()
      • TypstWriter.convert_header()
      • TypstWriter.convert_horizontal_rule()
      • TypstWriter.convert_image()
      • TypstWriter.convert_line_break()
      • TypstWriter.convert_link()
      • TypstWriter.convert_note()
      • TypstWriter.convert_ordered_list()
      • TypstWriter.convert_para()
      • TypstWriter.convert_plain()
      • TypstWriter.convert_raw_block()
      • TypstWriter.convert_raw_inline()
      • TypstWriter.convert_small_caps()
      • TypstWriter.convert_soft_break()
      • TypstWriter.convert_space()
      • TypstWriter.convert_str()
      • TypstWriter.convert_strikeout()
      • TypstWriter.convert_strong()
      • TypstWriter.convert_subscript()
      • TypstWriter.convert_superscript()
      • TypstWriter.convert_table()
      • TypstWriter.convert_underline()
  • markupit.writers.writer module
    • Writer
      • Writer.convert_block_quote()
      • Writer.convert_bullet_list()
      • Writer.convert_code()
      • Writer.convert_code_block()
      • Writer.convert_element()
      • Writer.convert_emph()
      • Writer.convert_header()
      • Writer.convert_horizontal_rule()
      • Writer.convert_image()
      • Writer.convert_line_break()
      • Writer.convert_link()
      • Writer.convert_note()
      • Writer.convert_ordered_list()
      • Writer.convert_para()
      • Writer.convert_plain()
      • Writer.convert_raw_block()
      • Writer.convert_raw_inline()
      • Writer.convert_small_caps()
      • Writer.convert_soft_break()
      • Writer.convert_space()
      • Writer.convert_str()
      • Writer.convert_strikeout()
      • Writer.convert_strong()
      • Writer.convert_subscript()
      • Writer.convert_superscript()
      • Writer.convert_table()
      • Writer.convert_underline()
      • Writer.write()
      • Writer.write_file()
  • Module contents
    • JsonWriter
      • JsonWriter.write()
      • JsonWriter.write_to_file()
    • LatexWriter
      • LatexWriter.convert_block_quote()
      • LatexWriter.convert_bullet_list()
      • LatexWriter.convert_code()
      • LatexWriter.convert_code_block()
      • LatexWriter.convert_emph()
      • LatexWriter.convert_header()
      • LatexWriter.convert_horizontal_rule()
      • LatexWriter.convert_image()
      • LatexWriter.convert_line_break()
      • LatexWriter.convert_link()
      • LatexWriter.convert_note()
      • LatexWriter.convert_ordered_list()
      • LatexWriter.convert_para()
      • LatexWriter.convert_plain()
      • LatexWriter.convert_raw_block()
      • LatexWriter.convert_raw_inline()
      • LatexWriter.convert_small_caps()
      • LatexWriter.convert_soft_break()
      • LatexWriter.convert_space()
      • LatexWriter.convert_str()
      • LatexWriter.convert_strikeout()
      • LatexWriter.convert_strong()
      • LatexWriter.convert_subscript()
      • LatexWriter.convert_superscript()
      • LatexWriter.convert_table()
      • LatexWriter.convert_underline()
    • TypstWriter
      • TypstWriter.convert_block_quote()
      • TypstWriter.convert_bullet_list()
      • TypstWriter.convert_code()
      • TypstWriter.convert_code_block()
      • TypstWriter.convert_emph()
      • TypstWriter.convert_header()
      • TypstWriter.convert_horizontal_rule()
      • TypstWriter.convert_image()
      • TypstWriter.convert_line_break()
      • TypstWriter.convert_link()
      • TypstWriter.convert_note()
      • TypstWriter.convert_ordered_list()
      • TypstWriter.convert_para()
      • TypstWriter.convert_plain()
      • TypstWriter.convert_raw_block()
      • TypstWriter.convert_raw_inline()
      • TypstWriter.convert_small_caps()
      • TypstWriter.convert_soft_break()
      • TypstWriter.convert_space()
      • TypstWriter.convert_str()
      • TypstWriter.convert_strikeout()
      • TypstWriter.convert_strong()
      • TypstWriter.convert_subscript()
      • TypstWriter.convert_superscript()
      • TypstWriter.convert_table()
      • TypstWriter.convert_underline()

Submodules

markupit.cli module

markupit.cli.convert(from_: ~markupit.supported_types.SupportedFrom = <typer.models.OptionInfo object>, to: ~markupit.supported_types.SupportedTo = <typer.models.OptionInfo object>, input: str = <typer.models.OptionInfo object>, output: str = <typer.models.OptionInfo object>) → None

Convert Markup Files

markupit.cli.version(version: bool = <typer.models.OptionInfo object>) → None

Markup Convertion CLI Tool

markupit.cli.version_callback(value: bool) → None

markupit.supported_types module

class markupit.supported_types.SupportedFrom(value)

Bases: str, Enum

An enumeration.

markdown = 'md'

class markupit.supported_types.SupportedTo(value)

Bases: str, Enum

An enumeration.

json = 'json'

latex = 'latex'

typst = 'typst'

Module contents