markdown

This module contains the classes that manipulate markdown content.

MkHeaderLevels(markdown: str)

Get the levels of the headers in a markdown.

Parameters:

• markdown (str) –

  The markdown string to parse.

Returns:

• MkLevel –

  The levels of the headers in the markdown.

Source code in pyobsidian/markdown.py

def __init__(self: Self, markdown: str) -> None:
    self.__markdown = markdown

markdown: str property

Markdown parsed.

Returns:

• str –

  The markdown parsed.

pattern: str property

The pattern to match the headers.

Returns:

• str –

  The pattern to match the headers.

get_headers(markdown: str, pattern: re.Pattern[str]) -> MkHeader staticmethod

Get the headers in the markdown string.

Parameters:

• markdown (str) –

  The markdown string to parse.

• pattern (Pattern[str]) –

  The pattern to match the headers.

Returns:

• MkHeader –

  The headers in the markdown string.

Source code in pyobsidian/markdown.py

@staticmethod
def get_headers(markdown: str, pattern: re.Pattern[str]) -> MkHeader:
    """Get the headers in the markdown string.

    Parameters
    ----------
    markdown : str
        The markdown string to parse.
    pattern : re.Pattern[str]
        The pattern to match the headers.

    Returns
    -------
    MkHeader
        The headers in the markdown string.
    """
    headers = [
        {
            'start': m.start(), 
            'end': m.end(),
            'level': len(m.group(1)),
            'content': m.group(2)
        }
        for m in re.finditer(pattern, markdown)
    ]
    return headers

get_levels() -> MkLevel

Get the levels of the headers in the markdown string.

Returns:

• MkLevel –

  The levels of the headers in the markdown string.

Source code in pyobsidian/markdown.py

def get_levels(self: Self) -> MkLevel:
    """Get the levels of the headers in the markdown string.

    Returns
    -------
    MkLevel
        The levels of the headers in the markdown string.
    """
    result: MkLevel = {}
    c_pattern = re.compile(self.pattern, re.MULTILINE)
    headers = self.get_headers(self.markdown, c_pattern)        
    for header in headers:
        level = str(header['level'])
        if level not in result:
            result[level] = []
        result[level].append({
            'start': header['start'],
            'end': header['end'],
            'content': header['content']
        })
    return result

parse_markdown(markdown: str) -> str

Parse the markdown string.

Parameters:

• markdown (str) –

  The markdown string to parse.

Returns:

• str –

  The parsed markdown string.

Source code in pyobsidian/markdown.py

def parse_markdown(markdown: str) -> str:
    """Parse the markdown string.

    Parameters
    ----------
    markdown : str
        The markdown string to parse.

    Returns
    -------
    str
        The parsed markdown string.
    """
    return '\\n'.join(markdown.split('\\n'))