Skip to content

Commit

Permalink
Revert "Update readme.md"
Browse files Browse the repository at this point in the history
This reverts commit 6c70978.
  • Loading branch information
SimonCropp committed Aug 11, 2019
1 parent 6c70978 commit a816f58
Showing 1 changed file with 5 additions and 10 deletions.
15 changes: 5 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,6 @@ If a line is `toc` it will be replaced with a table of contents
So if a markdown document contains the following:

<!-- snippet: tocBefore.txt -->
<a id='snippet-/docs/mdsource/toc/tocBefore.txt-tocBefore.txt-txt'/>
```txt
# Title
Expand All @@ -170,13 +169,12 @@ Text1
Text2
```
<sup>[snippet source](/docs/mdsource/toc/tocBefore.txt#L1-L11) [anchor](snippet-/docs/mdsource/toc/tocBefore.txt-tocBefore.txt-txt)</sup>
<sup>[snippet source](/docs/mdsource/toc/tocBefore.txt#L1-L11)</sup>
<!-- endsnippet -->

The result will be rendered:

<!-- snippet: tocAfter.txt -->
<a id='snippet-/docs/mdsource/toc/tocAfter.txt-tocAfter.txt-txt'/>
```txt
# Title
Expand All @@ -195,7 +193,7 @@ Text1
Text2
```
<sup>[snippet source](/docs/mdsource/toc/tocAfter.txt#L1-L16) [anchor](snippet-/docs/mdsource/toc/tocAfter.txt-tocAfter.txt-txt)</sup>
<sup>[snippet source](/docs/mdsource/toc/tocAfter.txt#L1-L16)</sup>
<!-- endsnippet -->


Expand Down Expand Up @@ -223,14 +221,13 @@ mdsnippets --toc-excludes heading1:heading2
When a .md file is written, a header is include. The default header is:

<!-- snippet: HeaderWriterTests.DefaultHeader.approved.txt -->
<a id='snippet-/src/Tests/HeaderWriterTests.DefaultHeader.approved.txt-HeaderWriterTests.DefaultHeader.approved.txt-txt'/>
```txt
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.
```
<sup>[snippet source](/src/Tests/HeaderWriterTests.DefaultHeader.approved.txt#L1-L4) [anchor](snippet-/src/Tests/HeaderWriterTests.DefaultHeader.approved.txt-HeaderWriterTests.DefaultHeader.approved.txt-txt)</sup>
<sup>[snippet source](/src/Tests/HeaderWriterTests.DefaultHeader.approved.txt#L1-L4)</sup>
<!-- endsnippet -->

To disable the header use `--write-header`
Expand All @@ -257,7 +254,6 @@ mdsnippets --header "GENERATED FILE\nSource File: {relativePath}"
Defines the format of `snippet source` links that appear under each snippet.

<!-- snippet: LinkFormat.cs -->
<a id='snippet-/src/MarkdownSnippets/Processing/LinkFormat.cs-LinkFormat.cs-cs'/>
```cs
namespace MarkdownSnippets
{
Expand All @@ -268,11 +264,10 @@ namespace MarkdownSnippets
}
}
```
<sup>[snippet source](/src/MarkdownSnippets/Processing/LinkFormat.cs#L1-L8) [anchor](snippet-/src/MarkdownSnippets/Processing/LinkFormat.cs-LinkFormat.cs-cs)</sup>
<sup>[snippet source](/src/MarkdownSnippets/Processing/LinkFormat.cs#L1-L8)</sup>
<!-- endsnippet -->

<!-- snippet: BuildLink -->
<a id='snippet-/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs-buildlink-cs'/>
```cs
if (linkFormat == LinkFormat.GitHub)
{
Expand All @@ -283,7 +278,7 @@ if (linkFormat == LinkFormat.Tfs)
return $"{path}&line={snippet.StartLine}&lineEnd={snippet.EndLine}";
}
```
<sup>[snippet source](/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs#L64-L73) [anchor](snippet-/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs-buildlink-cs)</sup>
<sup>[snippet source](/src/MarkdownSnippets/Processing/SnippetMarkdownHandling.cs#L50-L59)</sup>
<!-- endsnippet -->


Expand Down

0 comments on commit a816f58

Please sign in to comment.