markmv - v1.29.0
    Preparing search index...

    Variable generateBarrelConst

    generateBarrel: (directory: string, options: IndexOptions) => Promise<void> = generateIndex

    Generate barrel files for themed content aggregation (alias for generateIndex)

    Type declaration

      • (directory: string, options: IndexOptions): Promise<void>

      • 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);
          

      import { generateBarrel } from 'markmv';

      const options = {
        type: 'links',
        strategy: 'directory',
        name: 'api-docs.md',
        generateToc: true
      };
      await generateBarrel('docs/', options);

    Directory to generate barrel files for

    Barrel generation options (same as IndexOptions)

    Promise resolving when barrel generation is complete

    Settings

    Member Visibility