markmv - v1.41.7
    Preparing search index...

    Class HeaderBasedSplitStrategy

    Split strategy that divides content based on markdown headers.

    Splits the file at headers of a specified level, creating a new file for each section. This is ideal for documents with clear hierarchical structure where each major section can stand alone.

    Header-based splitting

      const strategy = new HeaderBasedSplitStrategy({
          headerLevel: 2,  // Split on ## headers
          outputDir: './sections/',
          filenamePattern: '{title}'
      });

      const result = await strategy.split(content, 'document.md');
      console.log(`Created ${result.sections.length} sections`);

    Hierarchy (View Summary)

    Index
    constructor
    options
    extractFrontmatter extractTitleFromHeader generateFilename getHeaderLevel isTargetHeader sanitizeFilename split numberOrDefault stringOrDefault
    options: SplitStrategyOptions

    The effective options for this strategy: the supplied options layered over the defaults set in the constructor.

    • Separates a leading frontmatter block from the rest of the content.

      Parameters

      • content: string

        The full file content.

      Returns { content: string; frontmatter: string }

      The split content.

      • content: string

        The content following the frontmatter, or the whole input when there is none.

      • frontmatter: string

        The leading --- delimited block including its delimiters, or an empty string when there is none.

    • Generates a filename for a section from the filenamePattern option.

      {title} is replaced by the sanitised title (or section-N when that is empty), {index} by the one-based index and {original} by the original filename without its extension. The original file's extension is appended, defaulting to .md.

      Parameters

      • title: string

        The section title.

      • index: number

        The zero-based position of the section.

      • originalFilename: string

        The name of the file being split.

      Returns string

      The generated filename.

    • Returns the header level of a line.

      Parameters

      • line: string

        The line to inspect.

      Returns number

      The number of leading # characters when the line is a header (the markers followed by whitespace or the end of the line), otherwise 0.

    • Checks whether a line is a header of exactly the given level.

      Parameters

      • line: string

        The line to inspect.

      • targetLevel: number

        The header level to match.

      Returns boolean

      True when the line's header level equals targetLevel; headers of other levels do not match.

    • Converts a string into a filename-safe slug.

      The text is lower-cased, characters other than letters, digits, spaces and hyphens are removed, whitespace becomes hyphens, repeated and surrounding hyphens are collapsed, and the result is limited to 50 characters.

      Parameters

      • str: string

        The text to convert.

      Returns string

      The slug, which may be empty.

    • Splits at every header of the headerLevel option (default 2).

      Only headers of exactly that level start a section, so deeper headers stay inside their parent section. Each section runs from its header to the line before the next matching header, and content before the first matching header is not placed in any section. An empty header produces a warning and a numbered title. If no matching header exists, an error is recorded.

      Parameters

      • content: string

        The full content of the file to split, including any frontmatter.

      • originalFilename: string

        The name of the file being split, used when generating section filenames.

      Returns Promise<SplitResult>

      The sections, titled by their header text, with the frontmatter as remaining content when preserveFrontmatter is on.

    • Returns value unless it is nullish or zero, in which case fallback is used, since zero is not a meaningful value for these options (header levels start at 1, size limits must be positive).

      Parameters

      • value: number | undefined
      • fallback: number

      Returns number

    • Returns value unless it is nullish or the empty string, in which case fallback is used, an empty string is treated as "no value supplied" rather than a meaningful value to preserve.

      Parameters

      • value: string | null | undefined
      • fallback: string

      Returns string

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods