🟠MdConverter.hs

Here is a detailed documentation for the Haskell module MdConverter

Module Documentation: MdConverter

The MdConverter module in Haskell is crafted to transform structured document data (Doc) into Markdown format. This module handles a variety of document components such as headers, sections, paragraphs, and various formatting styles, converting them into their corresponding Markdown representations.

Interface and Functionality Overview

Imported Modules

• Types: Utilizes the Doc data type which encapsulates different aspects of a document, such as textual content, authorship, and structural elements.

Key Functions

docToMarkdown

• Purpose: Main function that recursively converts a Doc into a Markdown formatted string.

• Parameters:

  • doc: The Doc structure to be converted.

  • indentLvl: Integer representing the current indentation level for nested structures.

• Returns: A String representing the Markdown formatted text.

Supporting Functions

listToMarkdown

• Purpose: Handles the conversion of list items within a Doc to Markdown format.

• Parameters: Same as docToMarkdown.

• Returns: Markdown formatted string representing a list.

headerToMarkdown

• Purpose: Converts header sections of a Doc into Markdown format, including metadata such as title.

• Parameters: Same as docToMarkdown.

• Returns: Markdown formatted string representing a document header.

sectionToMarkdown

• Purpose: Converts document sections into Markdown format, applying appropriate heading levels based on indentation.

• Parameters: Same as docToMarkdown.

• Returns: Markdown formatted string representing a document section.

Detailed Conversion Logic

• Headers: Transformed into Markdown headers with titles enclosed in horizontal rules.

• Sections: Prefixed with hashes (#) corresponding to their depth level in the document structure.

• Lists: Each item prefixed with a dash (-) and properly indented.

• Code Blocks: Enclosed in triple backticks.

• Text Styles: Bold, italic, and underlined text are handled using Markdown's respective syntax.

Conclusion

The MdConverter module serves as a pivotal component for applications requiring document processing and Markdown generation. Its comprehensive handling of various document elements ensures that complex documents can be accurately and effectively represented in Markdown format.

{-# OPTIONS_GHC -Wno-unrecognised-pragmas #-}
{-# HLINT ignore "Use lambda-case" #-}
{-# HLINT ignore "Use string literal" #-}
module MdConverter (docToMarkdown) where
import Types(Doc(..))

docToMarkdown :: Doc -> Int -> String
docToMarkdown doc indentLvl
    | isHeader doc = headerToMarkdown doc indentLvl
    | isDocument doc = x
    | isAuthor doc = "author: " ++ x ++ "\n"
    | isDate doc = "date: " ++ x ++ "\n"
    | isBody doc = x
    | isSection doc = sectionToMarkdown doc indentLvl
    | isParagraph doc = "\n" ++ x ++ "\n"
    | isCodeBlock doc = "\n```" ++ x ++ "```\n"
    | isList doc =  listToMarkdown doc indentLvl
    | isLink doc = "[" ++ x ++ "]" ++ "(" ++ link doc ++ ")"
    | isImage doc = " ![" ++ x ++ "]" ++ "(" ++ image doc ++ ")"
    | isBold doc = "**" ++ x ++ "**"
    | isUnderlined doc = "__" ++ x ++ "__"
    | isItalic doc = "*" ++ x ++ "*"
    | isCode doc = "`" ++ x ++ "`"
    | isString doc = string doc
    | otherwise = ""
    where
        x = concatMap (\d -> docToMarkdown d (indentLvl + 1)) (list doc)

listToMarkdown :: Doc -> Int -> String
listToMarkdown doc indentLvl =
    let indent = replicate (indentLvl * 0) ' '
        content = concatMap (\d -> "- " ++ filter (/= '\n')
         (docToMarkdown d (indentLvl + 1)) ++ "\n") (list doc)
    in  content ++ indent


headerToMarkdown :: Doc -> Int -> String
headerToMarkdown doc indentLvl =
    let indent = replicate (indentLvl * 0) ' '
        content = concatMap (\d -> docToMarkdown d (indentLvl + 1)) (list doc)
    in  "---\ntitle: " ++ string doc ++ "\n" ++
    content ++ indent ++ "---" ++ "\n"

sectionToMarkdown :: Doc -> Int -> String
sectionToMarkdown doc indentLvl =
    let indent = replicate (indentLvl * 0) ' '
        hashes = replicate (indentLvl - 1) '#'
        content = concatMap (\d -> docToMarkdown d (indentLvl + 1)) (list doc)
    in  if not (null (string doc)) then  "\n" ++
     hashes ++ " " ++ string doc ++ "\n"
       ++ content ++ indent else content