Markdown Functions
markdownRemoveUnfinishedSections
Given a file containing Markdown, remove header and any section
Arguments
- None
Examples
map.sh < $templateFile | markdownRemoveUnfinishedSections
Return codes
0- Success1- Environment error2- Argument error
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
- remove leading "dash space" if it exists (
-) - Semantically, if the phrase matches
[word]+[space][dash][space]. backtick quote the[word], otherwise skip - Prefix each line with a "dash space" (
-)
Reads standard input
reads input from stdin
Writes to standard output
formatted markdown list
Arguments
- none
Return codes
0- Success1- Environment error2- Argument error
markdownIndentHeading
Add an indent to all markdown headings
Usage
markdownIndentHeading
Add an indent to all markdown headings
Arguments
- none
Return codes
0- Success1- Environment error2- Argument error
markdownToConsole
Converts backticks, bold and italic to console colors.
Usage
markdownToConsole [ --help ]
Converts backticks, bold and italic to console colors.
Reads standard input
Markdown
Writes to standard output
decorated console output
Arguments
--help- Optional. Flag. Display this help.
Return codes
0- Success1- Environment error2- 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.
Arguments
indexFile ...- File. Required. One or more index files to check.--help- Optional. Flag. Display this help.--handler handler- Optional. Function. Use this error handler instead of the default error handler.
Return codes
0- Success1- Environment error2- Argument error