Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.38 KB

header.md

File metadata and controls

48 lines (33 loc) · 1.38 KB

Header

When a .md file is written, a header is include. The default header is:

GENERATED FILE - DO NOT EDIT
This file was generated by [MarkdownSnippets](https://github.com/SimonCropp/MarkdownSnippets).
Source File: {relativePath}
To change this file edit the source file and then run MarkdownSnippets.

snippet source | anchor

Disable Header

To disable the header use --write-header

mdsnippets --write-header false

Custom Header

To apply a custom header use --header. {relativePath} will be replaced with the relative path of the .source.md file.

mdsnippets --header "GENERATED FILE - Source File: {relativePath}"

Newlines in Header

To insert a newline use \n

mdsnippets --header "GENERATED FILE\nSource File: {relativePath}"