Skip to content

Markdown Functions

markdownRemoveUnfinishedSections

Remove markdown sections with tokens

Arguments

  • --preprocess preprocessFunction - Function. Optional. OneOrMore. A function to filter content via stdin prior to checking for tokens.
  • --handler handler - Function. Optional. Use this error handler instead of the default error handler.
  • --help - Flag. Optional. Display this help.

Examples

markdownRemoveUnfinishedSections --preprocess __removeRelLinks < inputFile > outputFile
map.sh < "$templateFile" | markdownRemoveUnfinishedSections

Return codes

  • 0

Environment

  • None

markdownFormatList

Simple function to make list-like things more list-like in Markdown

Usage

markdownFormatList

Simple function to make list-like things more list-like in Markdown

  1. Remove all trailing spaces from all lines
  2. remove leading "dash space" if it exists (-)
  3. Semantically, if the phrase matches [word]+[space][dash][space]. backtick quote the [word], otherwise skip
  4. Prefix each line with a "dash space" (-)

Location: bin/build/tools/markdown.sh

Arguments

  • none

Reads standard input

reads input from stdin

Writes to standard output

formatted markdown list

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

markdownIndentHeading

Add an indent to all markdown headings

Usage

markdownIndentHeading

Add an indent to all markdown headings

Location: bin/build/tools/markdown.sh

Arguments

  • none

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

markdownToConsole

Converts backticks, bold and italic to console colors.

Usage

markdownToConsole [ --help ]

Converts backticks, bold and italic to console colors.

Location: bin/build/tools/colors.sh

Arguments

  • --help - Flag. Optional. Display this help.

Reads standard input

Markdown

Writes to standard output

decorated console output

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

markdownHeadingsToConsole

Convert Markdown Heading lines to console

Usage

markdownHeadingsToConsole [ --help ] [ --handler handler ] [ --default defaultStyle ] [ --headings headingStyleList ]

Convert Markdown Heading lines to console

Location: bin/build/tools/colors.sh

Arguments

  • --help - Flag. Optional. Display this help.
  • --handler handler - Function. Optional. Use this error handler instead of the default error handler.
  • --default defaultStyle - String. Optional. Use this style on non-heading lines.
  • --headings headingStyleList - ColonDelimitedList. Optional. Styles represent each heading depth with the first being h1, `h2, etc.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

markdownCheckIndex

Displays any markdown files next to the given index file

Usage

markdownCheckIndex indexFile ... [ --help ] [ --handler handler ]

Displays any markdown files next to the given index file which are not found within the index file as links.

Location: bin/build/tools/markdown.sh

Arguments

  • indexFile ... - File. Required. One or more index files to check.
  • --help - Flag. Optional. Display this help.
  • --handler handler - Function. Optional. Use this error handler instead of the default error handler.

Return codes

  • 0 - Success
  • 1 - Environment error
  • 2 - Argument error

🛠️ Tools · ⬅ Top