Skip to content

topmark.presentation.markdown.paths

topmark / presentation / markdown / paths

Markdown-specific human-facing path presentation helpers.

This module adapts shared display-path policy to Markdown output by applying Markdown-specific escaping and STDIN annotations.

render_path_display_markdown 

render_path_display_markdown(ctx)

Render a short Markdown path label for headings and list items.

This helper formats get_display_path() for Markdown and annotates STDIN-backed content with _(via STDIN)_ when a synthetic filename is available.

The shared display-path policy determines the raw path label; this helper then applies Markdown-specific code-span escaping and STDIN annotation rendering.

Parameters:

Name Type Description Default
ctx ProcessingContext

Processing context containing the path to display.

 required

Returns:

Type Description
str

Short Markdown label for per-file headings and guidance messages.
Source code in src/topmark/presentation/markdown/paths.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def render_path_display_markdown(ctx: ProcessingContext) -> str:
    """Render a short Markdown path label for headings and list items.

    This helper formats
    [`get_display_path()`][topmark.presentation.shared.paths.get_display_path]
    for Markdown and annotates STDIN-backed content with ``_(via STDIN)_`` when a
    synthetic filename is available.

    The shared display-path policy determines the raw path label; this helper then
    applies Markdown-specific code-span escaping and STDIN annotation rendering.

    Args:
        ctx: Processing context containing the path to display.

    Returns:
        Short Markdown label for per-file headings and guidance messages.
    """
    path: str = get_display_path(ctx)
    code: str = markdown_code_span(path)

    if ctx.run_options.stdin_mode and bool(ctx.run_options.stdin_filename):
        return f"{code} _(via STDIN)_"

    return code