Skip to content

Add support for [[_TOC_]] #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bobzomer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for [[_TOC_]] #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MarkdigToc [![NuGet](https://img.shields.io/nuget/v/Leisn.MarkdigToc)](https://www.nuget.org/packages/Leisn.MarkdigToc/) [![NuGet](https://img.shields.io/nuget/v/Leisn.MarkdigToc.Signed)](https://www.nuget.org/packages/Leisn.MarkdigToc.Signed/)

MarkdigToc is a extension for [Markdig](https://github.com/xoofx/markdig) to generate table of content by parse [toc] in markdown document.
MarkdigToc is a extension for [Markdig](https://github.com/xoofx/markdig) to generate table of content by parse `[toc]` or `[[_toc_]]` in markdown document.

> Currently just for render to html.

Expand All @@ -23,6 +23,16 @@ var result=Markdown.ToHtml(@"
## t1.2
");
Console.WriteLine(result);

var result2=Markdown.ToHtml(@"
[[_TOC_]]
# t1
## t1.1
### t1.1.1
### t1.1.2
## t1.2
");
Console.WriteLine(result);
```

Use with custom options:
Expand Down
4 changes: 2 additions & 2 deletions Tests/RendererTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ public void MdFilesTest()
var md = File.ReadAllText(item + ".md");
var lintActual = Markdown.ToHtml(md, lintPipeline);
var lintExpected = File.ReadAllText(item + "-lint.html");
Assert.AreEqual(lintExpected, lintActual, $"Failed lint :{item}");
Assert.AreEqual(lintExpected.ReplaceLineEndings(), lintActual.ReplaceLineEndings(), $"Failed lint :{item}");

var noLintActual = Markdown.ToHtml(md, noLintPipelint);
var noLintExpected = File.ReadAllText(item + "-nolint.html");
Assert.AreEqual(noLintExpected, noLintActual, $"Failed nolint :{item}");
Assert.AreEqual(noLintExpected.ReplaceLineEndings(), noLintActual.ReplaceLineEndings(), $"Failed nolint :{item}");
}
}

Expand Down
16 changes: 16 additions & 0 deletions Tests/TestFiles/alternate-lint.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<nav><ul><li><a href='#t1'>t1</a><ul><li><a href='#t1.1'>t1.1</a></li><li><a href='#section'>1.2</a></li></ul></li><li><a href='#t2'>t2</a><ul><li><a href='#t2.1'>t2.1</a><ul><li><a href='#t2.1.1'>t2.1.1</a></li><li><a href='#t2.1.2'>t2.1.2</a></li><li><a href='#t2.1.3'>t2.1.3</a></li></ul></li><li><a href='#t2.2'>t2.2</a></li></ul></li><li><a href='#t3'>t3</a><ul><li><a href='#t3.1'>t3.1</a></li><li><a href='#t3.2'>t3.2</a><ul><li><a href='#t3.2.1'>t3.2.1</a></li><li><a href='#t3.2.2'>t3.2.2</a></li></ul></li></ul></li><li><a href='#t4'>t4</a></li></ul></nav>
<h1 id="t1">t1</h1>
<h2 id="t1.1">t1.1</h2>
<h2 id="section">1.2</h2>
<h1 id="t2">t2</h1>
<h2 id="t2.1">t2.1</h2>
<h3 id="t2.1.1">t2.1.1</h3>
<h3 id="t2.1.2">t2.1.2</h3>
<h3 id="t2.1.3">t2.1.3</h3>
<h2 id="t2.2">t2.2</h2>
<h1 id="t3">t3</h1>
<h2 id="t3.1">t3.1</h2>
<h2 id="t3.2">t3.2</h2>
<h3 id="t3.2.1">t3.2.1</h3>
<h3 id="t3.2.2">t3.2.2</h3>
<h1 id="t4">t4</h1>
16 changes: 16 additions & 0 deletions Tests/TestFiles/alternate-nolint.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<nav><ul><li><a href='#t1'>t1</a></li><ul><li><a href='#t1.1'>t1.1</a></li><li><a href='#section'>1.2</a></li></ul><li><a href='#t2'>t2</a></li><ul><li><a href='#t2.1'>t2.1</a></li><ul><li><a href='#t2.1.1'>t2.1.1</a></li><li><a href='#t2.1.2'>t2.1.2</a></li><li><a href='#t2.1.3'>t2.1.3</a></li></ul><li><a href='#t2.2'>t2.2</a></li></ul><li><a href='#t3'>t3</a></li><ul><li><a href='#t3.1'>t3.1</a></li><li><a href='#t3.2'>t3.2</a></li><ul><li><a href='#t3.2.1'>t3.2.1</a></li><li><a href='#t3.2.2'>t3.2.2</a></li></ul></ul><li><a href='#t4'>t4</a></li></ul></nav>
<h1 id="t1">t1</h1>
<h2 id="t1.1">t1.1</h2>
<h2 id="section">1.2</h2>
<h1 id="t2">t2</h1>
<h2 id="t2.1">t2.1</h2>
<h3 id="t2.1.1">t2.1.1</h3>
<h3 id="t2.1.2">t2.1.2</h3>
<h3 id="t2.1.3">t2.1.3</h3>
<h2 id="t2.2">t2.2</h2>
<h1 id="t3">t3</h1>
<h2 id="t3.1">t3.1</h2>
<h2 id="t3.2">t3.2</h2>
<h3 id="t3.2.1">t3.2.1</h3>
<h3 id="t3.2.2">t3.2.2</h3>
<h1 id="t4">t4</h1>
34 changes: 34 additions & 0 deletions Tests/TestFiles/alternate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
[[_TOC_]]



# t1

## t1.1

## 1.2

# t2

## t2.1

### t2.1.1

### t2.1.2

### t2.1.3

## t2.2

# t3

## t3.1

## t3.2

### t3.2.1

### t3.2.2

# t4

2 changes: 1 addition & 1 deletion Tests/Tests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net5.0</TargetFramework>
<TargetFramework>net9.0</TargetFramework>

<IsPackable>false</IsPackable>
</PropertyGroup>
Expand Down
80 changes: 43 additions & 37 deletions src/TocBlockParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public TocBlockParser(TocOptions options)
OpeningCharacters = new[] { '[' };
}

const string TOC = "[toc]";
readonly string[] TOCTags = { "[toc]", "[[_toc_]]" };
public override BlockState TryOpen(BlockProcessor processor)
{
if (processor.IsCodeIndent)
Expand All @@ -26,50 +26,56 @@ public override BlockState TryOpen(BlockProcessor processor)
var column = processor.Column;
var sourcePosition = line.Start;

var match = line.MatchLowercase(TOC);
if (!match)
return BlockState.None;
foreach (var toc in TOCTags)
{
var match = line.MatchLowercase(toc);
if (!match)
continue;

var c = line.CurrentChar;
for (int i = 0; i < TOC.Length; i++)
c = processor.NextChar();
var c = line.CurrentChar;
for (int i = 0; i < toc.Length; i++)
c = processor.NextChar();

StringSlice trivia = StringSlice.Empty;
if (processor.TrackTrivia && c.IsSpaceOrTab())
{
trivia = new StringSlice(processor.Line.Text, processor.Start, processor.Start);
processor.NextChar();
}
StringSlice trivia = StringSlice.Empty;
if (processor.TrackTrivia && c.IsSpaceOrTab())
{
trivia = new StringSlice(processor.Line.Text, processor.Start, processor.Start);
processor.NextChar();
}

var block = new TocBlock(this)
{
Column = column,
Span = { Start = sourcePosition },
TriviaAfterAtxHeaderChar = trivia,
TriviaBefore = processor.UseTrivia(sourcePosition - 1),
LinesBefore = processor.LinesBefore,
NewLine = processor.Line.NewLine,
};
processor.LinesBefore = null;
var block = new TocBlock(this)
{
Column = column,
Span = { Start = sourcePosition },
TriviaAfterAtxHeaderChar = trivia,
TriviaBefore = processor.UseTrivia(sourcePosition - 1),
LinesBefore = processor.LinesBefore,
NewLine = processor.Line.NewLine,
};
processor.LinesBefore = null;

processor.NewBlocks.Push(block);
if (!processor.TrackTrivia)
{
processor.GoToColumn(column + TOC.Length + 1);
}
TryParseAttributes?.Invoke(processor, ref processor.Line, block);
processor.NewBlocks.Push(block);
if (!processor.TrackTrivia)
{
processor.GoToColumn(column + toc.Length + 1);
}

block.Span.End = processor.Line.End;
TryParseAttributes?.Invoke(processor, ref processor.Line, block);

if (processor.TrackTrivia)
{
var wsa = new StringSlice(processor.Line.Text, processor.Line.End + 1, processor.Line.End);
block.TriviaAfter = wsa;
if (wsa.Overlaps(block.TriviaAfterAtxHeaderChar))
block.TriviaAfter = StringSlice.Empty;
block.Span.End = processor.Line.End;

if (processor.TrackTrivia)
{
var wsa = new StringSlice(processor.Line.Text, processor.Line.End + 1, processor.Line.End);
block.TriviaAfter = wsa;
if (wsa.Overlaps(block.TriviaAfterAtxHeaderChar))
block.TriviaAfter = StringSlice.Empty;
}

return BlockState.Break;
}

return BlockState.Break;
return BlockState.None;
}

public override bool Close(BlockProcessor processor, Block block)
Expand Down