concat-md

Functions

• concatMd()
• concatMdSync()
• gitHubLink()

Interfaces

• ConcatOptions

  • decreaseTitleLevels
  • dirNameAsTitle
  • fileNameAsTitle
  • hideAnchorLinks
  • ignore
  • joinString
  • sorter
  • startTitleLevelAt
  • titleKey
  • toc
  • tocLevel

function concatMd

concatMd: (dir: string, options?: ConcatOptions) => Promise<string>;

• Scans and concatenates all markdown files in given directory.

  Parameter dir

  is the directory to scan markdown files in.

  Parameter options

  are several parameters to modify concatenation behaviour.

  Returns

  concatenated contents of markdown files.

  Example 1

  import concatMd, { concatMdSync } from "concat-md"

function concatMdSync

concatMdSync: (dir: string, options?: ConcatOptions) => string;

• Scans and concatenates all markdown files in given directory.

  Parameter dir

  is the directory to scan markdown files in.

  Parameter options

  are several parameters to modify concatenation behaviour.

  Returns

  concatenated contents of markdown files.

  Example 1

  import concatMd, { concatMdSync } from "concat-md"

function gitHubLink

gitHubLink: (val: string) => string;