MarkdownSnippets

A dotnet tool that extract snippets from code files and merges them into markdown documents.

Support is available via a Tidelift Subscription.

Contents

Value Proposition
Behavior
Installation
Usage
Defining Snippets
Using Snippets
More Documentation
Security contact information

Value Proposition

Automatically extract snippets from code and injecting them into markdown documents has several benefits:

Snippets can be verified by a compiler or parser.
Tests can be run on snippets, or snippets can be pulled from existing tests.
Changes in code are automatically reflected in documentation.
Snippets are less likely to get out of sync with the main code-base.
Snippets in markdown is easier to create and maintain since any preferred editor can be used to edit them.

Behavior

Recursively scan the target directory for code files containing snippets. (See snippet exclusion).
Recursively scan the target directory for markdown (.md) files. (See Document Scanning).
Merge the snippets into those markdown files.

Installation

Ensure dotnet CLI is installed.

Install MarkdownSnippets.Tool

dotnet tool install -g MarkdownSnippets.Tool

Usage

mdsnippets C:\Code\TargetDirectory

If no directory is passed the current directory will be used, but only if it exists with a git repository directory tree. If not an error is returned.

Document Convention

There are two approaches scanning and modifying markdown files.

SourceTransform

This is the default.

source.md file

The file convention recursively scans the target directory for all *.source.md files. Once snippets are merged the .source.md to produce .md files. So for example readme.source.md would be merged with snippets to produce readme.md. Note that this process will overwrite any existing .md files that have matching .source.md files.

mdsource directory

There is a secondary convention that leverages the use of a directory named mdsource. Where .source.md files are placed in a mdsource sub-directory, the mdsource part of the file path will be removed when calculating the target path. This allows the .source.md to be grouped in a sub directory and avoid cluttering up the main documentation directory.

When using the mdsource convention, all references to other files, such as links and images, should specify the full path from the root of the repository. This will allow those links to work correctly in both the source and generated markdown files. Relative paths cannot work for both the source and the target file.

InPlaceOverwrite

Recursively scans the target directory for all *.md files and merges snippets into those files.

Can be enabled in mdsnippets.json config file.

{
  "Convention": "InPlaceOverwrite"
}

Moving from SourceTransform to InPlaceOverwrite

Ensure "WriteHeader": false is used in mdsnippets.json.
Ensure "ReadOnly": false is used in mdsnippets.json.
Ensure using the current stable version and a docs generation has run.
Delete all .source.md files.
Modify mdsnippets.json to add "Convention": "InPlaceOverwrite".
Run the docs generation.

DocumentExtensions

By default markdown files are scanned for processing. In some circumstances it is helpful to process non-markdown files.

mdsnippets --document-extensions "txt"

Mark resulting files as read only

To mark the resulting documents files as read only use -r or --readonly.

This can be helpful in preventing incorrectly editing the documents file instead of the .source. file conventions.

mdsnippets -r true

Defining Snippets

Any code wrapped in a convention based comment will be picked up. The comment needs to start with begin-snippet: which is followed by the key. The snippet is then terminated by end-snippet.

// begin-snippet: MySnippetName
My Snippet Code
// end-snippet

Named C# regions will also be picked up, with the name of the region used as the key.

To stop regions collapsing in Visual Studio disable 'enter outlining mode when files open'. See Visual Studio outlining.

UrlsAsSnippets

Urls to files to be included as snippets. Space separated for multiple values.

mdsnippets --urls-as-snippets "https://github.com/SimonCropp/MarkdownSnippets/snippet.cs"

Using Snippets

The keyed snippets can be used in any documentation .md file by adding the text snippet: KEY.

Then snippets with that key.

For example

Some blurb about the below snippet
snippet: MySnippetName

The resulting markdown will be:

<!-- snippet: MySnippetName -->
Some blurb about the below snippet
<a id='snippet-MySnippetName'></a>
```
My Snippet Code
```
<sup><a href='/relativeUrlToFile#L1-L11' title='Snippet source file'>snippet source</a> | <a href='#snippet-MySnippetName' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Notes:

The vertical bar ( | ) is used to separate adjacent links as per web accessibility recommendations: https://webaim.org/techniques/hypertext/hypertext_links#groups
H33: Supplementing link text with the title attribute

Including a snippet from the web

Snippets that start with http will be downloaded and the contents rendered. For example:

snippet: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/license.txt

Will render:

<!-- snippet: https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/license.txt -->
<a id='snippet-https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/license.txt'></a>
```txt
The MIT License (MIT)
...
```
<sup><a href='#snippet-https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/master/license.txt' title='Snippet source file'>anchor</a></sup>
<!-- endSnippet -->

Files are downloaded to %temp%MarkdownSnippets with a maximum of 100 files kept.

Including a full file

If no snippet is found matching the defined name. The target directory will be searched for a file matching that name. For example:

snippet: license.txt

Will render:

<!-- snippet: license.txt -->
<a id='snippet-license.txt'></a>
```txt
The MIT License (MIT)
...
```
<sup><a href='#snippet-license.txt' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->

Files are downloaded to %temp%MarkdownSnippets with a maximum of 100 files kept.

LinkFormat

Defines the format of snippet source links that appear under each snippet.

namespace MarkdownSnippets
{
    public enum LinkFormat
    {
        GitHub,
        Tfs,
        Bitbucket,
        GitLab
    }
}

^{snippet source | anchor}

if (linkFormat == LinkFormat.GitHub)
{
    return $"{path}#L{snippet.StartLine}-L{snippet.EndLine}";
}

if (linkFormat == LinkFormat.Tfs)
{
    return $"{path}&line={snippet.StartLine}&lineEnd={snippet.EndLine}";
}

if (linkFormat == LinkFormat.Bitbucket)
{
    return $"{path}#lines={snippet.StartLine}:{snippet.EndLine}";
}

if (linkFormat == LinkFormat.GitLab)
{
    return $"{path}#L{snippet.StartLine}-{snippet.EndLine}";
}

^{snippet source | anchor}

UrlPrefix

UrlPrefix allows a string to be defined that will prefix all snippet links. This is helpful when the markdown file are being hosted on a site that is no co-located with the source code files. It can be defined in the config file, the MsBuild task, and the dotnet tool.

More Documentation

Security contact information

To report a security vulnerability, use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Credits

Loosely based on some code from https://github.com/shiftkey/scribble.

Icon

Down by Alfredo Creates from The Noun Project.

License

ExternalRepositories/MarkdownSnippets

ErrorLooks like something went wrong!

About

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages