markmv - v1.41.7
    Preparing search index...

    Class LinkParser

    Parser for extracting and analyzing markdown links and references.

    This class uses the unified/remark ecosystem to parse markdown files and extract comprehensive link information including inline links, images, reference-style links, and link definitions.

    Basic usage

      const parser = new LinkParser();
      const parsed = await parser.parseFile('docs/readme.md');

      console.log(`Found ${parsed.links.length} links`);
      parsed.links.forEach(link => {
          console.log(`${link.type}: ${link.href} (line ${link.line})`);
      });

    Link validation

      const parser = new LinkParser();
      const parsed = await parser.parseFile('guide.md');

      const localLinks = parsed.links.filter(link =>
        link.type === 'internal' && !link.href.startsWith('http')
      );

      for (const link of localLinks) {
        const exists = await parser.validateInternalLink(link, parsed.filePath);
        if (!exists) {
          console.warn(`Broken link: ${link.href} at line ${link.line}`);
        }
      }
    Index
    constructor
    parseDirectory parseFile

    • Parses every markdown file found by recursively walking a directory. Files that fail to parse are skipped silently, so the result may hold fewer entries than there are matching files.

      Parameters

      • dirPath: string

        Directory to search.

      • extensions: string[] = ...

        File extensions to treat as markdown, including the leading dot.

      Returns Promise<ParsedMarkdownFile[]>

      The parsed files that were read successfully.

    • Parse a markdown file and extract all links, references, and metadata.

      Parameters

      • filePath: string

        Path to the markdown file to parse

      Returns Promise<ParsedMarkdownFile>

      Promise resolving to comprehensive file analysis

        const parser = new LinkParser();
        const result = await parser.parseFile('docs/api.md');

        console.log(`File: ${result.filePath}`);
        console.log(`Links: ${result.links.length}`);
        console.log(`References: ${result.references.length}`);

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods