​

mdxify.source_links

​

Functions

​

detect_github_repo_url

detect_github_repo_url() -> Optional[str]

​

get_relative_path

get_relative_path(file_path: Path, root_module: str) -> Optional[Path]

• file_path: Absolute path to the source file
• root_module: The root module name (e.g., ‘prefect’, ‘fastmcp’)

• Relative path from repo root, or None if unable to determine

​

generate_source_link

generate_source_link(repo_url: str, branch: str, file_path: Path, line_number: int, root_module: Optional[str] = None) -> Optional[str]

• repo_url: GitHub repository URL (e.g., https://github.com/owner/repo)
• branch: Git branch name
• file_path: Path to the source file
• line_number: Line number in the source file
• root_module: Root module name for finding relative paths

• GitHub URL to the specific line, or None if unable to generate

​

add_source_link_to_header

add_source_link_to_header(header: str, source_link: Optional[str], link_text: str = '[source]') -> str

• header: The markdown header (e.g., ”### function_name”)
• source_link: The source code URL
• link_text: Text for the link (default: “[source]”)

• Header with inline source link icon