markmv - v1.29.0
    Preparing search index...

    Function generateIndex

    • Generate index files with optional table of contents

      Parameters

      • directory: string

        Directory to generate index for

      • options: IndexOptions

        Index generation options

      Returns Promise<void>

      Promise resolving when index generation is complete

        import { generateIndex } from 'markmv';

      const options = {
      type: 'links',
      strategy: 'directory',
      generateToc: true,
      tocOptions: { minDepth: 2 }
      };
      await generateIndex('.', options);