Function generateLinkGraph

generateLinkGraph(
patterns: string[],
options?: GraphOperationOptions,
): Promise<GraphResult>

Generate interactive link graphs from markdown file relationships

Parameters

patterns: string[]
File patterns to analyze (supports globs)
options: GraphOperationOptions = ...
Graph generation options

Returns Promise<GraphResult>

Promise resolving to graph generation result

Example

Basic graph generation

import { generateLinkGraph } from 'markmv';

const result = await generateLinkGraph(['docs/**/*.md'], {
format: 'mermaid',
includeExternal: false
});

console.log('Generated Mermaid diagram:');
console.log(result.content);

Example

Interactive HTML visualization

import { generateLinkGraph } from 'markmv';

const result = await generateLinkGraph(['**/*.md'], {
format: 'html',
output: 'visualization.html',
includeImages: true
});

console.log('Interactive graph saved to: ' + result.outputFile);