isMarkdownFile() — astro Function Reference

Architecture documentation for the isMarkdownFile() function in util.ts from the astro codebase.

Function typescript CoreAstro RenderingEngine

Entity Profile

CoreAstro→ RenderingEngine→ isMarkdownFile() — astro Function Reference

Dependency Diagram

graph TD
  95f6a560_2d40_2fbd_eefa_9e06b2d9d332["isMarkdownFile()"]
  a3824e79_205c_305b_a44f_edee1ef5faa4["util.ts"]
  95f6a560_2d40_2fbd_eefa_9e06b2d9d332 -->|defined in| a3824e79_205c_305b_a44f_edee1ef5faa4
  style 95f6a560_2d40_2fbd_eefa_9e06b2d9d332 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/astro/src/core/util.ts lines 22–32

export function isMarkdownFile(fileId: string, option?: { suffix?: string }): boolean {
	if (hasSpecialQueries(fileId)) {
		return false;
	}
	const id = removeQueryString(fileId);
	const _suffix = option?.suffix ?? '';
	for (let markdownFileExtension of SUPPORTED_MARKDOWN_FILE_EXTENSIONS) {
		if (id.endsWith(`${markdownFileExtension}${_suffix}`)) return true;
	}
	return false;
}