Content_Input_Parsing_CIP_.md

graph LR
    Content_Readers["Content Readers"]
    JPEGReader["JPEGReader"]
    Markdown_Extensions["Markdown Extensions"]
    reStructuredText_Directives["reStructuredText Directives"]
    PlantUML_Renderer["PlantUML Renderer"]
    EXIF_Data_Parser["EXIF Data Parser"]
    JPEGReader -- "depends on" --> EXIF_Data_Parser
    Markdown_Extensions -- "integrates" --> PlantUML_Renderer
    reStructuredText_Directives -- "integrates" --> PlantUML_Renderer

Loading

Details

The pelican-plugins subsystem extends Pelican's core functionality by providing a diverse set of content processing and enhancement capabilities. At its core, a suite of Content Readers (e.g., AsciidocReader, CreoleReader, RMDReader) acts as the primary entry point for various document formats, transforming raw content into a structured representation. The JPEGReader is a specialized content reader that relies on the EXIF Data Parser to extract rich metadata from image files. Complementing the basic content parsing, Markdown Extensions and reStructuredText Directives offer advanced formatting and embedding options, allowing authors to include dynamic elements and external content. Notably, both Markdown and reStructuredText extensions can leverage the PlantUML Renderer to generate diagrams directly from textual descriptions, enriching the visual content of the generated static site. This modular design allows Pelican to support a wide array of input formats and advanced content features through a pluggable architecture.

Content Readers

These components are specialized plugins designed to parse and convert various document formats (AsciiDoc, Creole Wiki Markup, Emacs Org-mode, Textile, R Markdown) into a structured format that Pelican can process. Each reader is responsible for handling the syntax and metadata extraction specific to its format.

Related Classes/Methods:

• asciidoc_reader.asciidoc_reader.AsciiDocReader:48-114
• creole_reader.creole_reader.CreoleReader:32-95
• org_python_reader.org_python_reader.OrgPythonReader
• textile_reader.textile_reader.TextileReader:14-65
• rmd_reader.rmd_reader.RmdReader:61-119

JPEGReader

A specialized content reader for JPEG files, responsible for handling the syntax and metadata extraction specific to its format.

Related Classes/Methods:

• jpeg_reader.jpeg_reader.JpegReader:23-120

Markdown Extensions

This component represents a suite of plugins that enhance Pelican's default Markdown processing. It includes functionalities for custom inline Markdown, dynamic content insertion via liquid tags, and rendering of mathematical expressions.

Related Classes/Methods:

• md_inline_extension.pelican_inline_markdown_extension.PelicanInlineMarkdownExtension:44-69
• liquid_tags.mdx_liquid_tags.LiquidTagsExtension
• render_math.pelican_mathjax_markdown_extension.MathJaxExtension

reStructuredText Directives

This component provides custom directives to extend reStructuredText parsing within Pelican, allowing for the embedding of external content and styling elements like Bootstrap, Gist snippets, and Twitter content.

Related Classes/Methods:

• bootstrap-rst.directives.BootstrapDirective
• gist_directive.gist_directive.Gist
• twitter_bootstrap_rst_directives.bootstrap_rst_directives.TwitterBootstrapRstDirective

PlantUML Renderer

A utility component specifically designed for rendering PlantUML diagrams embedded within content. It processes PlantUML syntax and generates visual diagrams.

Related Classes/Methods:

• plantuml.plantuml_md.PlantUMLMarkdownExtension:77-92

EXIF Data Parser

A utility for extracting EXIF metadata from image files, primarily used by the JPEGReader to enrich content with image-specific information.

Related Classes/Methods:

• jpeg_reader.exiv2_parser.Exiv2Parser:15-53

FAQ