From 9d52732f180d189ed59331b119c51c04c29edd47 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Mon, 27 Jun 2016 22:25:32 +0900 Subject: [PATCH 1/9] wip normalize (issue #17) --- .../Renderers/Normalize/CodeBlockRenderer.cs | 52 +++ .../Renderers/Normalize/HeadingRenderer.cs | 35 ++ .../Normalize/NormalizeObjectRenderer.cs | 16 + .../Renderers/Normalize/NormalizeRenderer.cs | 323 ++++++++++++++++++ .../Renderers/Normalize/QuoteBlockRenderer.cs | 21 ++ src/Markdig/Renderers/TextRendererBase.cs | 33 ++ 6 files changed, 480 insertions(+) create mode 100644 src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/HeadingRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/NormalizeRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs new file mode 100644 index 00000000..4dce78cc --- /dev/null +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -0,0 +1,52 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// An Normalize renderer for a and . + /// + /// + public class CodeBlockRenderer : NormalizeObjectRenderer + { + public bool OutputAttributesOnPre { get; set; } + + protected override void Write(NormalizeRenderer renderer, CodeBlock obj) + { + var fencedCodeBlock = obj as FencedCodeBlock; + if (fencedCodeBlock != null) + { + var opening = new string(fencedCodeBlock.FencedChar, fencedCodeBlock.FencedCharCount); + renderer.Write(opening); + if (fencedCodeBlock.Info != null) + { + renderer.Write(fencedCodeBlock.Info); + } + if (fencedCodeBlock.Arguments != null) + { + renderer.Write(" ").Write(fencedCodeBlock.Arguments); + } + + var attributes = obj.TryGetAttributes(); + if (attributes != null) + { + renderer.Write(" "); + renderer.Write(attributes); + } + renderer.WriteLine(); + + renderer.WriteLeafRawLines(obj, true, false); + renderer.WriteLine(opening); + } + else + { + renderer.WriteLeafRawLines(obj, true, false, true); + renderer.WriteLine(); + } + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs new file mode 100644 index 00000000..9554eb7a --- /dev/null +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -0,0 +1,35 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Globalization; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// An Normalize renderer for a . + /// + /// + public class HeadingRenderer : NormalizeObjectRenderer + { + private static readonly string[] HeadingTexts = { + "#", + "##", + "###", + "####", + "#####", + "######", + }; + + protected override void Write(NormalizeRenderer renderer, HeadingBlock obj) + { + var headingText = obj.Level > 0 && obj.Level <= 6 + ? HeadingTexts[obj.Level - 1] + : new string('#', obj.Level); + + renderer.Write(headingText).Write(' '); + renderer.WriteLeafInline(obj); + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs new file mode 100644 index 00000000..f24daef2 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/NormalizeObjectRenderer.cs @@ -0,0 +1,16 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A base class for Normalize rendering and Markdown objects. + /// + /// The type of the object. + /// + public abstract class NormalizeObjectRenderer : MarkdownObjectRenderer where TObject : MarkdownObject + { + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs new file mode 100644 index 00000000..6b79d028 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -0,0 +1,323 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using System; +using System.IO; +using System.Runtime.CompilerServices; +using System.Text; +using Markdig.Helpers; +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// Default HTML renderer for a Markdown object. + /// + /// + public class NormalizeRenderer : TextRendererBase + { + /// + /// Initializes a new instance of the class. + /// + /// The writer. + public NormalizeRenderer(TextWriter writer) : base(writer) + { + // Default block renderers + ObjectRenderers.Add(new CodeBlockRenderer()); + //ObjectRenderers.Add(new ListRenderer()); + ObjectRenderers.Add(new HeadingRenderer()); + //ObjectRenderers.Add(new HtmlBlockRenderer()); + //ObjectRenderers.Add(new ParagraphRenderer()); + ObjectRenderers.Add(new QuoteBlockRenderer()); + //ObjectRenderers.Add(new ThematicBreakRenderer()); + + // Default inline renderers + //ObjectRenderers.Add(new AutolinkInlineRenderer()); + //ObjectRenderers.Add(new CodeInlineRenderer()); + //ObjectRenderers.Add(new DelimiterInlineRenderer()); + //ObjectRenderers.Add(new EmphasisInlineRenderer()); + //ObjectRenderers.Add(new LineBreakInlineRenderer()); + //ObjectRenderers.Add(new HtmlInlineRenderer()); + //ObjectRenderers.Add(new HtmlEntityInlineRenderer()); + //ObjectRenderers.Add(new LinkInlineRenderer()); + //ObjectRenderers.Add(new LiteralInlineRenderer()); + + EnableHtmlForInline = true; + EnableHtmlEscape = true; + } + + /// + /// Gets or sets a value indicating whether to ouput HTML tags when rendering. See remarks. + /// + /// + /// This is used by some renderers to disable HTML tags when rendering some inlines (for image links). + /// + public bool EnableHtmlForInline { get; set; } + + public bool EnableHtmlEscape { get; set; } + + /// + /// Gets or sets a value indicating whether to use implicit paragraph (optional <p>) + /// + public bool ImplicitParagraph { get; set; } + + /// + /// Writes the content escaped for HTML. + /// + /// The content. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(string content) + { + if (string.IsNullOrEmpty(content)) + return this; + + WriteEscape(content, 0, content.Length); + return this; + } + + /// + /// Writes the content escaped for HTML. + /// + /// The slice. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(ref StringSlice slice) + { + if (slice.Start > slice.End) + { + return this; + } + return WriteEscape(slice.Text, slice.Start, slice.Length); + } + + /// + /// Writes the content escaped for HTML. + /// + /// The slice. + /// This instance + [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] + public NormalizeRenderer WriteEscape(StringSlice slice) + { + return WriteEscape(ref slice); + } + + /// + /// Writes the content escaped for HTML. + /// + /// The content. + /// The offset. + /// The length. + /// This instance + public NormalizeRenderer WriteEscape(string content, int offset, int length) + { + if (string.IsNullOrEmpty(content) || length == 0) + return this; + + var end = offset + length; + int previousOffset = offset; + for (;offset < end; offset++) + { + switch (content[offset]) + { + case '<': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("<"); + } + previousOffset = offset + 1; + break; + case '>': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write(">"); + } + previousOffset = offset + 1; + break; + case '&': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("&"); + } + previousOffset = offset + 1; + break; + case '"': + Write(content, previousOffset, offset - previousOffset); + if (EnableHtmlEscape) + { + Write("""); + } + previousOffset = offset + 1; + break; + } + } + + Write(content, previousOffset, end - previousOffset); + return this; + } + + /// + /// Writes the URL escaped for HTML. + /// + /// The content. + /// This instance + public NormalizeRenderer WriteEscapeUrl(string content) + { + if (content == null) + return this; + + int previousPosition = 0; + int length = content.Length; + + for (var i = 0; i < length; i++) + { + var c = content[i]; + + if (c < 128) + { + var escape = HtmlHelper.EscapeUrlCharacter(c); + if (escape != null) + { + Write(content, previousPosition, i - previousPosition); + previousPosition = i + 1; + Write(escape); + } + } + else + { + Write(content, previousPosition, i - previousPosition); + previousPosition = i + 1; + + byte[] bytes; + if (c >= '\ud800' && c <= '\udfff' && previousPosition < length) + { + bytes = Encoding.UTF8.GetBytes(new[] { c, content[previousPosition] }); + // Skip next char as it is decoded above + i++; + previousPosition = i + 1; + } + else + { + bytes = Encoding.UTF8.GetBytes(new[] { c }); + } + + for (var j = 0; j < bytes.Length; j++) + { + Write($"%{bytes[j]:X2}"); + } + } + } + + Write(content, previousPosition, length - previousPosition); + return this; + } + + /// + /// Writes the attached on the specified . + /// + /// The object. + /// + public NormalizeRenderer WriteAttributes(MarkdownObject obj) + { + if (obj == null) throw new ArgumentNullException(nameof(obj)); + return WriteAttributes(obj.TryGetAttributes()); + } + + /// + /// Writes the specified . + /// + /// The attributes to render. + /// This instance + public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) + { + if (attributes == null) + { + return this; + } + + if (attributes.Id != null) + { + Write(" id=\"").WriteEscape(attributes.Id).Write("\""); + } + + if (attributes.Classes != null && attributes.Classes.Count > 0) + { + Write(" class=\""); + for (int i = 0; i < attributes.Classes.Count; i++) + { + var cssClass = attributes.Classes[i]; + if (i > 0) + { + Write(" "); + } + WriteEscape(cssClass); + } + Write("\""); + } + + if (attributes.Properties != null && attributes.Properties.Count > 0) + { + foreach (var property in attributes.Properties) + { + Write(" ").Write(property.Key); + if (property.Value != null) + { + Write("=").Write("\""); + WriteEscape(property.Value); + Write("\""); + } + } + } + + return this; + } + + /// + /// Writes the lines of a + /// + /// The leaf block. + /// if set to true write end of lines. + /// if set to true escape the content for HTML + /// This instance + public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool escape, bool indent = false) + { + if (leafBlock == null) throw new ArgumentNullException(nameof(leafBlock)); + if (leafBlock.Lines.Lines != null) + { + var lines = leafBlock.Lines; + var slices = lines.Lines; + for (int i = 0; i < lines.Count; i++) + { + if (!writeEndOfLines && i > 0) + { + WriteLine(); + } + + if (indent) + { + Write(" "); + } + + if (escape) + { + WriteEscape(ref slices[i].Slice); + } + else + { + Write(ref slices[i].Slice); + } + if (writeEndOfLines) + { + WriteLine(); + } + } + } + return this; + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs new file mode 100644 index 00000000..bd4329fe --- /dev/null +++ b/src/Markdig/Renderers/Normalize/QuoteBlockRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class QuoteBlockRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, QuoteBlock obj) + { + renderer.PushIndent(obj.QuoteChar + " "); + renderer.WriteChildren(obj); + renderer.PopIndent(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/TextRendererBase.cs b/src/Markdig/Renderers/TextRendererBase.cs index b4ac3649..8c24758b 100644 --- a/src/Markdig/Renderers/TextRendererBase.cs +++ b/src/Markdig/Renderers/TextRendererBase.cs @@ -2,6 +2,7 @@ // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. using System; +using System.Collections.Generic; using System.IO; using System.Runtime.CompilerServices; using Markdig.Helpers; @@ -70,6 +71,7 @@ namespace Markdig.Renderers { private bool previousWasLine; private char[] buffer; + private readonly List indents; /// /// Initializes a new instance of the class. @@ -80,6 +82,7 @@ namespace Markdig.Renderers buffer = new char[1024]; // We assume that we are starting as if we had previously a newline previousWasLine = true; + indents = new List(); } /// @@ -95,6 +98,31 @@ namespace Markdig.Renderers return (T)this; } + public void PushIndent(string indent) + { + if (indent == null) throw new ArgumentNullException(nameof(indent)); + indents.Add(indent); + } + + public void PopIndent() + { + // TODO: Check + indents.RemoveAt(indents.Count - 1); + } + + private void WriteIndent() + { + if (previousWasLine) + { + previousWasLine = false; + for (int i = 0; i < indents.Count; i++) + { + Writer.Write(indents[i]); + } + } + } + + /// /// Writes the specified content. /// @@ -103,6 +131,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T Write(string content) { + WriteIndent(); previousWasLine = false; Writer.Write(content); return (T) this; @@ -142,6 +171,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T Write(char content) { + WriteIndent(); previousWasLine = content == '\n'; Writer.Write(content); return (T) this; @@ -161,6 +191,7 @@ namespace Markdig.Renderers return (T) this; } + WriteIndent(); previousWasLine = false; if (offset == 0 && content.Length == length) { @@ -189,6 +220,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T WriteLine() { + WriteIndent(); Writer.WriteLine(); previousWasLine = true; return (T) this; @@ -202,6 +234,7 @@ namespace Markdig.Renderers [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] public T WriteLine(string content) { + WriteIndent(); previousWasLine = true; Writer.WriteLine(content); return (T) this; From 6ac2429e2a237a09b683b899abc6a79fbc789078 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 28 Jun 2016 23:37:52 +0900 Subject: [PATCH 2/9] Add normalize renderers for core CommonMark components (wip #17) --- src/Markdig.Tests/Markdig.Tests.csproj | 1 + src/Markdig.Tests/TestNormalize.cs | 121 +++++++ src/Markdig/Markdown.cs | 37 ++ src/Markdig/Parsers/ThematicBreakParser.cs | 4 +- .../Renderers/Normalize/CodeBlockRenderer.cs | 4 +- .../Renderers/Normalize/HeadingRenderer.cs | 2 +- .../Inlines/AutolinkInlineRenderer.cs | 19 ++ .../Normalize/Inlines/CodeInlineRenderer.cs | 21 ++ .../Inlines/DelimiterInlineRenderer.cs | 20 ++ .../Inlines/EmphasisInlineRenderer.cs | 22 ++ .../Inlines/LineBreakInlineRenderer.cs | 25 ++ .../Normalize/Inlines/LinkInlineRenderer.cs | 38 +++ .../Inlines/LiteralInlineRenderer.cs | 19 ++ .../NormalizeHtmlEntityInlineRenderer.cs | 18 + .../Inlines/NormalizeHtmlInlineRenderer.cs | 18 + .../Renderers/Normalize/ListRenderer.cs | 73 ++++ .../Renderers/Normalize/NormalizeRenderer.cs | 320 ++++-------------- .../Renderers/Normalize/ParagraphRenderer.cs | 21 ++ .../Normalize/ThematicBreakRenderer.cs | 19 ++ src/Markdig/Syntax/ThematicBreakBlock.cs | 4 + 20 files changed, 553 insertions(+), 253 deletions(-) create mode 100644 src/Markdig.Tests/TestNormalize.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ListRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ParagraphRenderer.cs create mode 100644 src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs diff --git a/src/Markdig.Tests/Markdig.Tests.csproj b/src/Markdig.Tests/Markdig.Tests.csproj index 412202bb..287acd6e 100644 --- a/src/Markdig.Tests/Markdig.Tests.csproj +++ b/src/Markdig.Tests/Markdig.Tests.csproj @@ -64,6 +64,7 @@ + diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs new file mode 100644 index 00000000..269c7467 --- /dev/null +++ b/src/Markdig.Tests/TestNormalize.cs @@ -0,0 +1,121 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. + +using System; +using NUnit.Framework; + +namespace Markdig.Tests +{ + [TestFixture] + public class TestNormalize + { + + [Test] + public void TestParagraph() + { + AssertNormalize("This is a plain paragraph"); + AssertNormalize(@"This +is +a +plain +paragraph"); + } + + [Test] + public void TestParagraphMulti() + { + AssertNormalize(@"line1 + +line2 + +line3"); + } + + [Test] + public void TestListUnordered() + { + AssertNormalize(@" +- a +- b +- c +"); + } + + [Test] + public void TestListOrdered() + { + AssertNormalize(@" +1. a +2. b +3. c +"); + } + + [Test] + public void TestHeaderAndParagraph() + { + AssertNormalize(@" +# heading + +paragraph +"); + } + + + [Test] + public void TestQuote() + { + AssertNormalize(@" +> test1 +> +> test2 +"); + } + + + [Test] + public void TestEmphasis() + { + AssertNormalize("This is a plain **paragraph**"); + AssertNormalize("This is a plain *paragraph*"); + AssertNormalize("This is a plain _paragraph_"); + AssertNormalize("This is a plain __paragraph__"); + AssertNormalize("This is a pl*ai*n **paragraph**"); + } + + [Test] + public void TestLinks() + { + AssertNormalize("This is a [link](http://company.com)"); + AssertNormalize("This is an ![image](http://company.com)"); + } + + + public void AssertNormalize(string input, string expected = null) + { + expected = expected ?? input; + input = NormText(input); + expected = NormText(expected); + + var result = Markdown.Normalize(input); + result = NormText(result); + + Console.WriteLine("```````````````````Source"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(input)); + Console.WriteLine("```````````````````Result"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(result)); + Console.WriteLine("```````````````````Expected"); + Console.WriteLine(TestParser.DisplaySpaceAndTabs(expected)); + Console.WriteLine("```````````````````"); + Console.WriteLine(); + + TextAssert.AreEqual(expected, result); + } + + private static string NormText(string text) + { + return text.Trim().Replace("\r\n", "\n").Replace('\r', '\n'); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Markdown.cs b/src/Markdig/Markdown.cs index ae030995..fc754313 100644 --- a/src/Markdig/Markdown.cs +++ b/src/Markdig/Markdown.cs @@ -6,6 +6,7 @@ using System.IO; using Markdig.Extensions.SelfPipeline; using Markdig.Parsers; using Markdig.Renderers; +using Markdig.Renderers.Normalize; using Markdig.Syntax; namespace Markdig @@ -15,6 +16,42 @@ namespace Markdig /// public static partial class Markdown { + /// + /// Normalizes the specified markdown to a normalized markdown text. + /// + /// The markdown. + /// The pipeline. + /// A normalized markdown text. + public static string Normalize(string markdown, MarkdownPipeline pipeline = null) + { + var writer = new StringWriter(); + Normalize(markdown, writer, pipeline); + return writer.ToString(); + } + + /// + /// Normalizes the specified markdown to a normalized markdown text. + /// + /// The markdown. + /// The destination that will receive the result of the conversion. + /// The pipeline. + /// A normalized markdown text. + public static MarkdownDocument Normalize(string markdown, TextWriter writer, MarkdownPipeline pipeline = null) + { + pipeline = pipeline ?? new MarkdownPipelineBuilder().Build(); + pipeline = CheckForSelfPipeline(pipeline, markdown); + + // We override the renderer with our own writer + var renderer = new NormalizeRenderer(writer); + pipeline.Setup(renderer); + + var document = Parse(markdown, pipeline); + renderer.Render(document); + writer.Flush(); + + return document; + } + /// /// Converts a Markdown string to HTML. /// diff --git a/src/Markdig/Parsers/ThematicBreakParser.cs b/src/Markdig/Parsers/ThematicBreakParser.cs index b29c7cb0..d55fbf11 100644 --- a/src/Markdig/Parsers/ThematicBreakParser.cs +++ b/src/Markdig/Parsers/ThematicBreakParser.cs @@ -88,7 +88,9 @@ namespace Markdig.Parsers processor.NewBlocks.Push(new ThematicBreakBlock(this) { Column = processor.Column, - Span = new SourceSpan(startPosition, line.End) + Span = new SourceSpan(startPosition, line.End), + ThematicChar = breakChar, + ThematicCharCount = breakCharCount }); return BlockState.BreakDiscard; } diff --git a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs index 4dce78cc..c7ab8f60 100644 --- a/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs +++ b/src/Markdig/Renderers/Normalize/CodeBlockRenderer.cs @@ -39,12 +39,12 @@ namespace Markdig.Renderers.Normalize } renderer.WriteLine(); - renderer.WriteLeafRawLines(obj, true, false); + renderer.WriteLeafRawLines(obj, true); renderer.WriteLine(opening); } else { - renderer.WriteLeafRawLines(obj, true, false, true); + renderer.WriteLeafRawLines(obj, true, true); renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs index 9554eb7a..ee7c91d3 100644 --- a/src/Markdig/Renderers/Normalize/HeadingRenderer.cs +++ b/src/Markdig/Renderers/Normalize/HeadingRenderer.cs @@ -29,7 +29,7 @@ namespace Markdig.Renderers.Normalize renderer.Write(headingText).Write(' '); renderer.WriteLeafInline(obj); - renderer.WriteLine(); + renderer.WriteLine().WriteLine(); } } } \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs new file mode 100644 index 00000000..6dede810 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/AutolinkInlineRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for an . + /// + /// + public class AutolinkInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, AutolinkInline obj) + { + renderer.Write('<').Write(obj.Url).Write('>'); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs new file mode 100644 index 00000000..7eace1e4 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/CodeInlineRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class CodeInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, CodeInline obj) + { + renderer.Write(obj.Delimiter); + renderer.Write(obj.Content); // TODO: escape ` + renderer.Write(obj.Delimiter); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs new file mode 100644 index 00000000..54709ea4 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/DelimiterInlineRenderer.cs @@ -0,0 +1,20 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class DelimiterInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, DelimiterInline obj) + { + renderer.Write(obj.ToLiteral()); + renderer.WriteChildren(obj); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs new file mode 100644 index 00000000..36633f99 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/EmphasisInlineRenderer.cs @@ -0,0 +1,22 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for an . + /// + /// + public class EmphasisInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, EmphasisInline obj) + { + var emphasisText = new string(obj.DelimiterChar, obj.IsDouble ? 2 : 1); + renderer.Write(emphasisText); + renderer.WriteChildren(obj); + renderer.Write(emphasisText); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs new file mode 100644 index 00000000..4cdad0fe --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LineBreakInlineRenderer.cs @@ -0,0 +1,25 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LineBreakInlineRenderer : NormalizeObjectRenderer + { + /// + /// Gets or sets a value indicating whether to render this softline break as a Normalize hardline break tag (<br />) + /// + public bool RenderAsHardlineBreak { get; set; } + + protected override void Write(NormalizeRenderer renderer, LineBreakInline obj) + { + // TODO: handle hard + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs new file mode 100644 index 00000000..a2dddac8 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LinkInlineRenderer.cs @@ -0,0 +1,38 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LinkInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, LinkInline link) + { + if (link.IsImage) + { + renderer.Write('!'); + } + renderer.Write('['); + renderer.WriteChildren(link); + renderer.Write(']'); + if (!string.IsNullOrEmpty(link.Url)) + { + renderer.Write('(').Write(link.Url); + + if (!string.IsNullOrEmpty(link.Title)) + { + renderer.Write(" \""); + renderer.Write(link.Title); // TODO: escape " + renderer.Write("\""); + } + + renderer.Write(')'); + } + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs new file mode 100644 index 00000000..3b4e410f --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/LiteralInlineRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + /// + public class LiteralInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, LiteralInline obj) + { + renderer.Write(ref obj.Content); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs new file mode 100644 index 00000000..2d7883c7 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlEntityInlineRenderer.cs @@ -0,0 +1,18 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + public class NormalizeHtmlEntityInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, HtmlEntityInline obj) + { + renderer.Write(obj.Transcoded); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs new file mode 100644 index 00000000..33bc8536 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/Inlines/NormalizeHtmlInlineRenderer.cs @@ -0,0 +1,18 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax.Inlines; + +namespace Markdig.Renderers.Normalize.Inlines +{ + /// + /// A Normalize renderer for a . + /// + public class NormalizeHtmlInlineRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, HtmlInline obj) + { + renderer.Write(obj.Tag); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs new file mode 100644 index 00000000..bf204740 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -0,0 +1,73 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Globalization; +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ListRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ListBlock listBlock) + { + renderer.EnsureLine(); + if (listBlock.IsOrdered) + { + int index = 0; + if (listBlock.OrderedStart != null) + { + switch (listBlock.BulletType) + { + case '1': + int.TryParse(listBlock.OrderedStart, out index); + break; + } + } + foreach (var item in listBlock) + { + var listItem = (ListItemBlock)item; + renderer.EnsureLine(); + + renderer.Write(index + ""); + renderer.Write(listBlock.OrderedDelimiter); + renderer.Write(' '); + renderer.PushIndent(" "); // TODO: output accurate indent + renderer.WriteChildren(listItem); + renderer.PopIndent(); + if (!listBlock.IsLoose) + { + renderer.WriteLine(); + } + + switch (listBlock.BulletType) + { + case '1': + index++; + break; + } + } + } + else + { + foreach (var item in listBlock) + { + var listItem = (ListItemBlock)item; + renderer.EnsureLine(); + renderer.Write("- "); + renderer.PushIndent(" "); + renderer.WriteChildren(listItem); + renderer.PopIndent(); + if (!listBlock.IsLoose) + { + renderer.WriteLine(); + } + } + } + renderer.WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 6b79d028..585ad7f0 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -9,6 +9,7 @@ using System.Text; using Markdig.Helpers; using Markdig.Renderers.Html; using Markdig.Syntax; +using Markdig.Renderers.Normalize.Inlines; namespace Markdig.Renderers.Normalize { @@ -26,265 +27,92 @@ namespace Markdig.Renderers.Normalize { // Default block renderers ObjectRenderers.Add(new CodeBlockRenderer()); - //ObjectRenderers.Add(new ListRenderer()); + ObjectRenderers.Add(new ListRenderer()); ObjectRenderers.Add(new HeadingRenderer()); - //ObjectRenderers.Add(new HtmlBlockRenderer()); - //ObjectRenderers.Add(new ParagraphRenderer()); + ObjectRenderers.Add(new HtmlBlockRenderer()); + ObjectRenderers.Add(new ParagraphRenderer()); ObjectRenderers.Add(new QuoteBlockRenderer()); - //ObjectRenderers.Add(new ThematicBreakRenderer()); + ObjectRenderers.Add(new ThematicBreakRenderer()); // Default inline renderers - //ObjectRenderers.Add(new AutolinkInlineRenderer()); - //ObjectRenderers.Add(new CodeInlineRenderer()); - //ObjectRenderers.Add(new DelimiterInlineRenderer()); - //ObjectRenderers.Add(new EmphasisInlineRenderer()); - //ObjectRenderers.Add(new LineBreakInlineRenderer()); - //ObjectRenderers.Add(new HtmlInlineRenderer()); - //ObjectRenderers.Add(new HtmlEntityInlineRenderer()); - //ObjectRenderers.Add(new LinkInlineRenderer()); - //ObjectRenderers.Add(new LiteralInlineRenderer()); - - EnableHtmlForInline = true; - EnableHtmlEscape = true; + ObjectRenderers.Add(new AutolinkInlineRenderer()); + ObjectRenderers.Add(new CodeInlineRenderer()); + ObjectRenderers.Add(new DelimiterInlineRenderer()); + ObjectRenderers.Add(new EmphasisInlineRenderer()); + ObjectRenderers.Add(new LineBreakInlineRenderer()); + ObjectRenderers.Add(new NormalizeHtmlInlineRenderer()); + ObjectRenderers.Add(new NormalizeHtmlEntityInlineRenderer()); + ObjectRenderers.Add(new LinkInlineRenderer()); + ObjectRenderers.Add(new LiteralInlineRenderer()); } - /// - /// Gets or sets a value indicating whether to ouput HTML tags when rendering. See remarks. - /// - /// - /// This is used by some renderers to disable HTML tags when rendering some inlines (for image links). - /// - public bool EnableHtmlForInline { get; set; } + ///// + ///// Writes the attached on the specified . + ///// + ///// The object. + ///// + //public NormalizeRenderer WriteAttributes(MarkdownObject obj) + //{ + // if (obj == null) throw new ArgumentNullException(nameof(obj)); + // return WriteAttributes(obj.TryGetAttributes()); + //} - public bool EnableHtmlEscape { get; set; } + ///// + ///// Writes the specified . + ///// + ///// The attributes to render. + ///// This instance + //public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) + //{ + // if (attributes == null) + // { + // return this; + // } - /// - /// Gets or sets a value indicating whether to use implicit paragraph (optional <p>) - /// - public bool ImplicitParagraph { get; set; } + // if (attributes.Id != null) + // { + // Write(" id=\"").WriteEscape(attributes.Id).Write("\""); + // } - /// - /// Writes the content escaped for HTML. - /// - /// The content. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(string content) - { - if (string.IsNullOrEmpty(content)) - return this; + // if (attributes.Classes != null && attributes.Classes.Count > 0) + // { + // Write(" class=\""); + // for (int i = 0; i < attributes.Classes.Count; i++) + // { + // var cssClass = attributes.Classes[i]; + // if (i > 0) + // { + // Write(" "); + // } + // WriteEscape(cssClass); + // } + // Write("\""); + // } - WriteEscape(content, 0, content.Length); - return this; - } + // if (attributes.Properties != null && attributes.Properties.Count > 0) + // { + // foreach (var property in attributes.Properties) + // { + // Write(" ").Write(property.Key); + // if (property.Value != null) + // { + // Write("=").Write("\""); + // WriteEscape(property.Value); + // Write("\""); + // } + // } + // } - /// - /// Writes the content escaped for HTML. - /// - /// The slice. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(ref StringSlice slice) - { - if (slice.Start > slice.End) - { - return this; - } - return WriteEscape(slice.Text, slice.Start, slice.Length); - } - - /// - /// Writes the content escaped for HTML. - /// - /// The slice. - /// This instance - [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - public NormalizeRenderer WriteEscape(StringSlice slice) - { - return WriteEscape(ref slice); - } - - /// - /// Writes the content escaped for HTML. - /// - /// The content. - /// The offset. - /// The length. - /// This instance - public NormalizeRenderer WriteEscape(string content, int offset, int length) - { - if (string.IsNullOrEmpty(content) || length == 0) - return this; - - var end = offset + length; - int previousOffset = offset; - for (;offset < end; offset++) - { - switch (content[offset]) - { - case '<': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("<"); - } - previousOffset = offset + 1; - break; - case '>': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write(">"); - } - previousOffset = offset + 1; - break; - case '&': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("&"); - } - previousOffset = offset + 1; - break; - case '"': - Write(content, previousOffset, offset - previousOffset); - if (EnableHtmlEscape) - { - Write("""); - } - previousOffset = offset + 1; - break; - } - } - - Write(content, previousOffset, end - previousOffset); - return this; - } - - /// - /// Writes the URL escaped for HTML. - /// - /// The content. - /// This instance - public NormalizeRenderer WriteEscapeUrl(string content) - { - if (content == null) - return this; - - int previousPosition = 0; - int length = content.Length; - - for (var i = 0; i < length; i++) - { - var c = content[i]; - - if (c < 128) - { - var escape = HtmlHelper.EscapeUrlCharacter(c); - if (escape != null) - { - Write(content, previousPosition, i - previousPosition); - previousPosition = i + 1; - Write(escape); - } - } - else - { - Write(content, previousPosition, i - previousPosition); - previousPosition = i + 1; - - byte[] bytes; - if (c >= '\ud800' && c <= '\udfff' && previousPosition < length) - { - bytes = Encoding.UTF8.GetBytes(new[] { c, content[previousPosition] }); - // Skip next char as it is decoded above - i++; - previousPosition = i + 1; - } - else - { - bytes = Encoding.UTF8.GetBytes(new[] { c }); - } - - for (var j = 0; j < bytes.Length; j++) - { - Write($"%{bytes[j]:X2}"); - } - } - } - - Write(content, previousPosition, length - previousPosition); - return this; - } - - /// - /// Writes the attached on the specified . - /// - /// The object. - /// - public NormalizeRenderer WriteAttributes(MarkdownObject obj) - { - if (obj == null) throw new ArgumentNullException(nameof(obj)); - return WriteAttributes(obj.TryGetAttributes()); - } - - /// - /// Writes the specified . - /// - /// The attributes to render. - /// This instance - public NormalizeRenderer WriteAttributes(HtmlAttributes attributes) - { - if (attributes == null) - { - return this; - } - - if (attributes.Id != null) - { - Write(" id=\"").WriteEscape(attributes.Id).Write("\""); - } - - if (attributes.Classes != null && attributes.Classes.Count > 0) - { - Write(" class=\""); - for (int i = 0; i < attributes.Classes.Count; i++) - { - var cssClass = attributes.Classes[i]; - if (i > 0) - { - Write(" "); - } - WriteEscape(cssClass); - } - Write("\""); - } - - if (attributes.Properties != null && attributes.Properties.Count > 0) - { - foreach (var property in attributes.Properties) - { - Write(" ").Write(property.Key); - if (property.Value != null) - { - Write("=").Write("\""); - WriteEscape(property.Value); - Write("\""); - } - } - } - - return this; - } + // return this; + //} /// /// Writes the lines of a /// /// The leaf block. /// if set to true write end of lines. - /// if set to true escape the content for HTML /// This instance - public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool escape, bool indent = false) + public NormalizeRenderer WriteLeafRawLines(LeafBlock leafBlock, bool writeEndOfLines, bool indent = false) { if (leafBlock == null) throw new ArgumentNullException(nameof(leafBlock)); if (leafBlock.Lines.Lines != null) @@ -303,14 +131,8 @@ namespace Markdig.Renderers.Normalize Write(" "); } - if (escape) - { - WriteEscape(ref slices[i].Slice); - } - else - { - Write(ref slices[i].Slice); - } + Write(ref slices[i].Slice); + if (writeEndOfLines) { WriteLine(); diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs new file mode 100644 index 00000000..81d747d5 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -0,0 +1,21 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ParagraphRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ParagraphBlock obj) + { + renderer.EnsureLine(); + renderer.WriteLeafInline(obj); + renderer.WriteLine().WriteLine(); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs new file mode 100644 index 00000000..2aa90c15 --- /dev/null +++ b/src/Markdig/Renderers/Normalize/ThematicBreakRenderer.cs @@ -0,0 +1,19 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using Markdig.Syntax; + +namespace Markdig.Renderers.Normalize +{ + /// + /// A Normalize renderer for a . + /// + /// + public class ThematicBreakRenderer : NormalizeObjectRenderer + { + protected override void Write(NormalizeRenderer renderer, ThematicBreakBlock obj) + { + renderer.WriteLine(new string(obj.ThematicChar, obj.ThematicCharCount)); + } + } +} \ No newline at end of file diff --git a/src/Markdig/Syntax/ThematicBreakBlock.cs b/src/Markdig/Syntax/ThematicBreakBlock.cs index ebf66bb1..c6839373 100644 --- a/src/Markdig/Syntax/ThematicBreakBlock.cs +++ b/src/Markdig/Syntax/ThematicBreakBlock.cs @@ -17,5 +17,9 @@ namespace Markdig.Syntax public ThematicBreakBlock(BlockParser parser) : base(parser) { } + + public char ThematicChar { get; set; } + + public int ThematicCharCount { get; set; } } } \ No newline at end of file From b20b1113855d30a6da0c9e9026fca453ae199b34 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 28 Jun 2016 23:55:01 +0900 Subject: [PATCH 3/9] Try to workaround tight/loose lists and paragraphs (wip #17) --- src/Markdig.Tests/TestNormalize.cs | 2 +- src/Markdig/Renderers/Normalize/ListRenderer.cs | 13 ++++--------- .../Renderers/Normalize/NormalizeRenderer.cs | 2 ++ .../Renderers/Normalize/ParagraphRenderer.cs | 11 +++++++++-- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/src/Markdig.Tests/TestNormalize.cs b/src/Markdig.Tests/TestNormalize.cs index 269c7467..fae3f763 100644 --- a/src/Markdig.Tests/TestNormalize.cs +++ b/src/Markdig.Tests/TestNormalize.cs @@ -68,7 +68,7 @@ paragraph { AssertNormalize(@" > test1 -> +> > test2 "); } diff --git a/src/Markdig/Renderers/Normalize/ListRenderer.cs b/src/Markdig/Renderers/Normalize/ListRenderer.cs index bf204740..a60c8cea 100644 --- a/src/Markdig/Renderers/Normalize/ListRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ListRenderer.cs @@ -15,6 +15,8 @@ namespace Markdig.Renderers.Normalize protected override void Write(NormalizeRenderer renderer, ListBlock listBlock) { renderer.EnsureLine(); + var compact = renderer.CompactParagraph; + renderer.CompactParagraph = !listBlock.IsLoose; if (listBlock.IsOrdered) { int index = 0; @@ -38,11 +40,6 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(" "); // TODO: output accurate indent renderer.WriteChildren(listItem); renderer.PopIndent(); - if (!listBlock.IsLoose) - { - renderer.WriteLine(); - } - switch (listBlock.BulletType) { case '1': @@ -61,12 +58,10 @@ namespace Markdig.Renderers.Normalize renderer.PushIndent(" "); renderer.WriteChildren(listItem); renderer.PopIndent(); - if (!listBlock.IsLoose) - { - renderer.WriteLine(); - } } } + + renderer.CompactParagraph = compact; renderer.WriteLine(); } } diff --git a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs index 585ad7f0..17d91189 100644 --- a/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs +++ b/src/Markdig/Renderers/Normalize/NormalizeRenderer.cs @@ -46,6 +46,8 @@ namespace Markdig.Renderers.Normalize ObjectRenderers.Add(new LiteralInlineRenderer()); } + public bool CompactParagraph { get; set; } + ///// ///// Writes the attached on the specified . ///// diff --git a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs index 81d747d5..755042a4 100644 --- a/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs +++ b/src/Markdig/Renderers/Normalize/ParagraphRenderer.cs @@ -13,9 +13,16 @@ namespace Markdig.Renderers.Normalize { protected override void Write(NormalizeRenderer renderer, ParagraphBlock obj) { - renderer.EnsureLine(); + if (!renderer.CompactParagraph) + { + renderer.EnsureLine(); + } renderer.WriteLeafInline(obj); - renderer.WriteLine().WriteLine(); + if (!renderer.IsLastInContainer && !renderer.CompactParagraph) + { + renderer.WriteLine(); + renderer.WriteLine(); + } } } } \ No newline at end of file From 3897e875eee24c3fc4538f9b71d4de5ae1d8df1d Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Sun, 15 Oct 2017 23:29:02 +0200 Subject: [PATCH 4/9] Add KeepOpeningDigits and DiscardDots options to AutoIdentifiers to match GitHub behavior --- .../AutoIdentifiers/AutoIdentifierExtension.cs | 9 +++++++-- .../AutoIdentifiers/AutoIdentifierOptions.cs | 17 ++++++++++++++++- src/Markdig/Helpers/LinkHelper.cs | 16 ++++++++-------- 3 files changed, 31 insertions(+), 11 deletions(-) diff --git a/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierExtension.cs b/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierExtension.cs index 22fa75f1..e2134795 100644 --- a/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierExtension.cs +++ b/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierExtension.cs @@ -1,4 +1,4 @@ -// Copyright (c) Alexandre Mutel. All rights reserved. +// Copyright (c) Alexandre Mutel. All rights reserved. // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. @@ -143,7 +143,12 @@ namespace Markdig.Extensions.AutoIdentifiers stripRenderer.Render(headingBlock.Inline); var headingText = headingWriter.ToString(); headingWriter.GetStringBuilder().Length = 0; - headingText = LinkHelper.Urilize(headingText, (options & AutoIdentifierOptions.AllowOnlyAscii) != 0); + + // TODO: Should we have a struct with more configure optionss for LinkHelper.Urilize? + headingText = LinkHelper.Urilize(headingText, + (options & AutoIdentifierOptions.AllowOnlyAscii) != 0, + (options & AutoIdentifierOptions.KeepOpeningDigits) != 0, + (options & AutoIdentifierOptions.DiscardDots) != 0); var baseHeadingId = string.IsNullOrEmpty(headingText) ? "section" : headingText; int index = 0; diff --git a/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierOptions.cs b/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierOptions.cs index 86d1b105..dde55ecc 100644 --- a/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierOptions.cs +++ b/src/Markdig/Extensions/AutoIdentifiers/AutoIdentifierOptions.cs @@ -1,4 +1,4 @@ -// Copyright (c) Alexandre Mutel. All rights reserved. +// Copyright (c) Alexandre Mutel. All rights reserved. // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. using System; @@ -21,6 +21,11 @@ namespace Markdig.Extensions.AutoIdentifiers /// Default = AutoLink | AllowOnlyAscii, + /// + /// Renders auto identifiers like GitHub. + /// + GitHub = Default | KeepOpeningDigits | DiscardDots, + /// /// Allows to link to a header by using the same text as the header for the link label. Default is true /// @@ -30,5 +35,15 @@ namespace Markdig.Extensions.AutoIdentifiers /// Allows only ASCII characters in the url (HTML 5 allows to have UTF8 characters). Default is true /// AllowOnlyAscii = 2, + + /// + /// Allows to keep digits starting a heading (by default, it keeps only characters starting from the first letter) + /// + KeepOpeningDigits = 4, + + /// + /// Discard dots when computing an identifier. + /// + DiscardDots = 8 } } \ No newline at end of file diff --git a/src/Markdig/Helpers/LinkHelper.cs b/src/Markdig/Helpers/LinkHelper.cs index 04014e72..875cf8c7 100644 --- a/src/Markdig/Helpers/LinkHelper.cs +++ b/src/Markdig/Helpers/LinkHelper.cs @@ -1,4 +1,4 @@ -// Copyright (c) Alexandre Mutel. All rights reserved. +// Copyright (c) Alexandre Mutel. All rights reserved. // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. using System; @@ -18,10 +18,10 @@ namespace Markdig.Helpers return TryParseAutolink(ref text, out link, out isEmail); } - public static string Urilize(string headingText, bool allowOnlyAscii) + public static string Urilize(string headingText, bool allowOnlyAscii, bool keepOpeningDigits = false, bool discardDots = false) { var headingBuffer = StringBuilderCache.Local(); - bool hasLetter = false; + bool hasLetter = keepOpeningDigits && headingText.Length > 0 && char.IsLetterOrDigit(headingText[0]); bool previousIsSpace = false; for (int i = 0; i < headingText.Length; i++) { @@ -47,7 +47,7 @@ namespace Markdig.Helpers } else if (hasLetter) { - if (IsReservedPunctuation(c)) + if (IsReservedPunctuation(c, discardDots)) { if (previousIsSpace) { @@ -67,7 +67,7 @@ namespace Markdig.Helpers else if (!previousIsSpace && c.IsWhitespace()) { var pc = headingBuffer[headingBuffer.Length - 1]; - if (!IsReservedPunctuation(pc)) + if (!IsReservedPunctuation(pc, discardDots)) { headingBuffer.Append('-'); } @@ -81,7 +81,7 @@ namespace Markdig.Helpers while (headingBuffer.Length > 0) { var c = headingBuffer[headingBuffer.Length - 1]; - if (IsReservedPunctuation(c)) + if (IsReservedPunctuation(c, false)) { headingBuffer.Length--; } @@ -97,9 +97,9 @@ namespace Markdig.Helpers } [MethodImpl(MethodImplOptionPortable.AggressiveInlining)] - private static bool IsReservedPunctuation(char c) + private static bool IsReservedPunctuation(char c, bool discardDots) { - return c == '_' || c == '-' || c == '.'; + return c == '_' || c == '-' || (!discardDots && c == '.'); } public static bool TryParseAutolink(ref StringSlice text, out string link, out bool isEmail) From 42472085a62dfb86e229f1cbb16e24aead6a9741 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Sun, 15 Oct 2017 23:31:14 +0200 Subject: [PATCH 5/9] Add mdtoc simple tool to generate a markdown TOC from a local markdown file or github link to a markdown file --- src/markdig.sln | 11 ++- src/mdtoc/App.config | 6 ++ src/mdtoc/Program.cs | 101 +++++++++++++++++++++++++++ src/mdtoc/Properties/AssemblyInfo.cs | 39 +++++++++++ src/mdtoc/mdtoc.csproj | 58 +++++++++++++++ 5 files changed, 214 insertions(+), 1 deletion(-) create mode 100644 src/mdtoc/App.config create mode 100644 src/mdtoc/Program.cs create mode 100644 src/mdtoc/Properties/AssemblyInfo.cs create mode 100644 src/mdtoc/mdtoc.csproj diff --git a/src/markdig.sln b/src/markdig.sln index 69cd9e0e..8e4bf05f 100644 --- a/src/markdig.sln +++ b/src/markdig.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 -VisualStudioVersion = 15.0.26430.16 +VisualStudioVersion = 15.0.26730.16 MinimumVisualStudioVersion = 10.0.40219.1 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{061866E2-005C-4D13-A338-EA464BBEC60F}" ProjectSection(SolutionItems) = preProject @@ -26,6 +26,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Markdig.WebApp", "Markdig.W EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "UnicodeNormDApp", "UnicodeNormDApp\UnicodeNormDApp.csproj", "{33FFC0B9-0187-44F9-9424-BB5AF5B4FB84}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "mdtoc", "mdtoc\mdtoc.csproj", "{E3CDFF0F-5BFC-42E9-BDBA-2797651900A2}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -52,8 +54,15 @@ Global {33FFC0B9-0187-44F9-9424-BB5AF5B4FB84}.Debug|Any CPU.Build.0 = Debug|Any CPU {33FFC0B9-0187-44F9-9424-BB5AF5B4FB84}.Release|Any CPU.ActiveCfg = Release|Any CPU {33FFC0B9-0187-44F9-9424-BB5AF5B4FB84}.Release|Any CPU.Build.0 = Release|Any CPU + {E3CDFF0F-5BFC-42E9-BDBA-2797651900A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E3CDFF0F-5BFC-42E9-BDBA-2797651900A2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E3CDFF0F-5BFC-42E9-BDBA-2797651900A2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E3CDFF0F-5BFC-42E9-BDBA-2797651900A2}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {D068F7B6-6ACC-456C-A2E1-10EA746D956D} + EndGlobalSection EndGlobal diff --git a/src/mdtoc/App.config b/src/mdtoc/App.config new file mode 100644 index 00000000..731f6de6 --- /dev/null +++ b/src/mdtoc/App.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/src/mdtoc/Program.cs b/src/mdtoc/Program.cs new file mode 100644 index 00000000..13c657b5 --- /dev/null +++ b/src/mdtoc/Program.cs @@ -0,0 +1,101 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Net.Http; +using Markdig; +using Markdig.Extensions.AutoIdentifiers; +using Markdig.Renderers; +using Markdig.Renderers.Html; +using Markdig.Syntax; + +namespace mdtoc +{ + /// + /// A tool to generate a markdown TOC from a markdown local file or a github link to a markdown file. + /// + class Program + { + static void Error(string message) + { + Console.WriteLine(message); + Environment.Exit(1); + } + + static void Main(string[] args) + { + if (args.Length != 1 || args[0] == "--help" || args[0] == "-help" || args[0] == "/?" || args[0] == "/help") + { + Error("Usage: mdtoc [markdown file path | http github URL]"); + return; + } + + var path = args[0]; + string markdown = null; + if (path.StartsWith("https:")) + { + Uri uri; + if (!Uri.TryCreate(path, UriKind.Absolute, out uri)) + { + Error($"Unable to parse Uri `{path}`"); + return; + } + // Special handling of github URL to access the raw content instead + if (uri.Host == "github.com") + { + // https://github.com/lunet-io/scriban/blob/master/doc/language.md + // https://raw.githubusercontent.com/lunet-io/scriban/master/doc/language.md + var newPath = uri.AbsolutePath; + var paths = new List(newPath.Split(new char[] {'/'}, StringSplitOptions.RemoveEmptyEntries)); + if (paths.Count < 5 || paths[2] != "blob") + { + Error($"Invalid github.com URL `{path}`"); + return; + } + paths.RemoveAt(2); // remove blob + uri = new Uri($"https://raw.githubusercontent.com/{(string.Join("/", paths))}"); + } + + var httpClient = new HttpClient(); + markdown = httpClient.GetStringAsync(uri).ConfigureAwait(false).GetAwaiter().GetResult(); + } + else + { + markdown = File.ReadAllText(path); + } + + var pipeline = new MarkdownPipelineBuilder().UseAutoIdentifiers(AutoIdentifierOptions.GitHub).Build(); + var doc = Markdown.Parse(markdown, pipeline); + + // Precomputes the minHeading + var headings = doc.Descendants().ToList(); + int minHeading = int.MaxValue; + int maxHeading = int.MinValue; + foreach (var heading in headings) + { + minHeading = Math.Min(minHeading, heading.Level); + maxHeading = Math.Max(maxHeading, heading.Level); + } + + var writer = Console.Out; + // Use this htmlWriter to write content of headings into link label + var htmlWriter = new HtmlRenderer(writer) {EnableHtmlForInline = true}; + foreach (var heading in headings) + { + var indent = heading.Level - minHeading; + for (int i = 0; i < indent; i++) + { + // - Start Of Heading + writer.Write(" "); + } + writer.Write("- ["); + htmlWriter.WriteLeafInline(heading); + writer.Write($"](#{heading.GetAttributes().Id})"); + writer.WriteLine(); + } + } + } +} diff --git a/src/mdtoc/Properties/AssemblyInfo.cs b/src/mdtoc/Properties/AssemblyInfo.cs new file mode 100644 index 00000000..5d211f85 --- /dev/null +++ b/src/mdtoc/Properties/AssemblyInfo.cs @@ -0,0 +1,39 @@ +// Copyright (c) Alexandre Mutel. All rights reserved. +// This file is licensed under the BSD-Clause 2 license. +// See the license.txt file in the project root for more information. +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("mdtoc")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("Alexandre Mutel")] +[assembly: AssemblyProduct("mdtoc")] +[assembly: AssemblyCopyright("Copyright © 2017 - Alexandre Mutel")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("e3cdff0f-5bfc-42e9-bdba-2797651900a2")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/src/mdtoc/mdtoc.csproj b/src/mdtoc/mdtoc.csproj new file mode 100644 index 00000000..fb24835d --- /dev/null +++ b/src/mdtoc/mdtoc.csproj @@ -0,0 +1,58 @@ + + + + + Debug + AnyCPU + {E3CDFF0F-5BFC-42E9-BDBA-2797651900A2} + Exe + mdtoc + mdtoc + v4.6.1 + 512 + true + + + AnyCPU + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + + + + + + + + + + {8a58a7e2-627c-4f41-933f-5ac92adfab48} + Markdig + + + + \ No newline at end of file From d6a705d76cdcf0843fe6a69a88072982d8e728d8 Mon Sep 17 00:00:00 2001 From: maulwuff Date: Tue, 17 Oct 2017 09:13:30 +0200 Subject: [PATCH 6/9] new: support nomnoml diagrams --- src/Markdig/Extensions/Diagrams/DiagramExtension.cs | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Markdig/Extensions/Diagrams/DiagramExtension.cs b/src/Markdig/Extensions/Diagrams/DiagramExtension.cs index 417a4b23..484f034c 100644 --- a/src/Markdig/Extensions/Diagrams/DiagramExtension.cs +++ b/src/Markdig/Extensions/Diagrams/DiagramExtension.cs @@ -25,6 +25,7 @@ namespace Markdig.Extensions.Diagrams var codeRenderer = htmlRenderer.ObjectRenderers.FindExact(); // TODO: Add other well known diagram languages codeRenderer.BlocksAsDiv.Add("mermaid"); + codeRenderer.BlocksAsDiv.Add("nomnoml"); } } } From 80ef9d27994b259f8b15197c56c72030aec7f659 Mon Sep 17 00:00:00 2001 From: maulwuff Date: Tue, 17 Oct 2017 09:13:46 +0200 Subject: [PATCH 7/9] doc: added nomnoml specs --- readme.md | 2 +- src/Markdig.Tests/Specs/DiagramsSpecs.md | 31 ++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 6ffb6de3..7eaf985d 100644 --- a/readme.md +++ b/readme.md @@ -47,7 +47,7 @@ You can **try Markdig online** and compare it to other implementations on [babel - [**Emoji**](src/Markdig.Tests/Specs/EmojiSpecs.md) support (inspired from [Markdown-it](https://markdown-it.github.io/)) - [**SmartyPants**](src/Markdig.Tests/Specs/SmartyPantsSpecs.md) (inspired from [Daring Fireball - SmartyPants](https://daringfireball.net/projects/smartypants/)) - [**Bootstrap**](src/Markdig.Tests/Specs/BootstrapSpecs.md) class (to output bootstrap class) - - [**Diagrams**](src/Markdig.Tests/Specs/DiagramsSpecs.md) extension whenever a fenced code block contains a special keyword, it will be converted to a div block with the content as-is (currently, supports only for [`mermaid` diagrams](https://knsv.github.io/mermaid/)) + - [**Diagrams**](src/Markdig.Tests/Specs/DiagramsSpecs.md) extension whenever a fenced code block contains a special keyword, it will be converted to a div block with the content as-is (currently, supports [`mermaid`](https://knsv.github.io/mermaid/) and [`nomnoml`](https://github.com/skanaar/nomnoml) diagrams) - [**YAML frontmatter**](src/Markdig.Tests/Specs/YamlSpecs.md) to parse without evaluating the frontmatter and to discard it from the HTML output (typically used for previewing without the frontmatter in MarkdownEditor) - [**JIRA links**](src/Markdig.Tests/Specs/JiraLinks.md) to automatically generate links for JIRA project references (Thanks to @clarkd: https://github.com/clarkd/MarkdigJiraLinker) - Compatible with .NET 3.5, 4.0+ and .NET Core (`netstandard1.1+`) diff --git a/src/Markdig.Tests/Specs/DiagramsSpecs.md b/src/Markdig.Tests/Specs/DiagramsSpecs.md index 31fa8616..495c8fbc 100644 --- a/src/Markdig.Tests/Specs/DiagramsSpecs.md +++ b/src/Markdig.Tests/Specs/DiagramsSpecs.md @@ -23,4 +23,35 @@ graph TD; ```````````````````````````````` +## nomnoml diagrams + +Using a fenced code block with the `nomnoml` language info will output a `
` instead of a `pre/code` block: + +```````````````````````````````` example +```nomnoml +[example| + propertyA: Int + propertyB: string +| + methodA() + methodB() +| + [subA]--[subB] + [subA]-:>[sub C] +] +``` +. +
[example| + propertyA: Int + propertyB: string +| + methodA() + methodB() +| + [subA]--[subB] + [subA]-:>[sub C] +] +
+```````````````````````````````` + TODO: Add other text diagram languages \ No newline at end of file From 2147e434f79cf562dd72893202092d7f478ea649 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 17 Oct 2017 22:58:25 +0200 Subject: [PATCH 8/9] Add support for single table header row without a table body rows (#141) --- src/Markdig.Tests/Specs/PipeTableSpecs.md | 33 +++++ src/Markdig.Tests/Specs/Specs.cs | 121 ++++++++++++++++-- src/Markdig.Tests/Specs/Specs.tt | 5 +- .../Extensions/Tables/HtmlTableRenderer.cs | 2 +- .../Extensions/Tables/PipeTableOptions.cs | 2 +- .../Extensions/Tables/PipeTableParser.cs | 28 +++- src/Markdig/Extensions/Tables/Table.cs | 2 +- 7 files changed, 175 insertions(+), 18 deletions(-) diff --git a/src/Markdig.Tests/Specs/PipeTableSpecs.md b/src/Markdig.Tests/Specs/PipeTableSpecs.md index acddfbb4..3dab4c32 100644 --- a/src/Markdig.Tests/Specs/PipeTableSpecs.md +++ b/src/Markdig.Tests/Specs/PipeTableSpecs.md @@ -513,6 +513,39 @@ a | b ```````````````````````````````` +** Rule #9** + +It is possible to have a single row header only: + +```````````````````````````````` example +a | b +-- | -- +. + + + + + + + +
ab
+```````````````````````````````` + +```````````````````````````````` example +|a|b|c +|---|---|---| +. + + + + + + + + +
abc
+```````````````````````````````` + ** Tests ** Tests trailing spaces after pipes diff --git a/src/Markdig.Tests/Specs/Specs.cs b/src/Markdig.Tests/Specs/Specs.cs index 45bd5979..96725a74 100644 --- a/src/Markdig.Tests/Specs/Specs.cs +++ b/src/Markdig.Tests/Specs/Specs.cs @@ -1,4 +1,4 @@ -using System; +using System; using NUnit.Framework; namespace Markdig.Tests @@ -17259,9 +17259,9 @@ namespace Markdig.Tests TestParser.TestSpec("a | b\n-- | --\n[This is a link with a | inside the label](http://google.com) | 1", "\n\n\n\n\n\n\n\n\n\n\n\n\n
ab
This is a link with a | inside the label1
", "pipetables|advanced"); } } - // ** Tests ** + // ** Rule #9** // - // Tests trailing spaces after pipes + // It is possible to have a single row header only: [TestFixture] public partial class TestExtensionsPipeTable { @@ -17272,6 +17272,64 @@ namespace Markdig.Tests // Section: Extensions Pipe Table // // The following CommonMark: + // a | b + // -- | -- + // + // Should be rendered as: + // + // + // + // + // + // + // + //
ab
+ + Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 22, "Extensions Pipe Table"); + TestParser.TestSpec("a | b\n-- | --", "\n\n\n\n\n\n\n
ab
", "pipetables|advanced"); + } + } + [TestFixture] + public partial class TestExtensionsPipeTable + { + [Test] + public void Example023() + { + // Example 23 + // Section: Extensions Pipe Table + // + // The following CommonMark: + // |a|b|c + // |---|---|---| + // + // Should be rendered as: + // + // + // + // + // + // + // + // + //
abc
+ + Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 23, "Extensions Pipe Table"); + TestParser.TestSpec("|a|b|c\n|---|---|---|", "\n\n\n\n\n\n\n\n
abc
", "pipetables|advanced"); + } + } + // ** Tests ** + // + // Tests trailing spaces after pipes + [TestFixture] + public partial class TestExtensionsPipeTable + { + [Test] + public void Example024() + { + // Example 24 + // Section: Extensions Pipe Table + // + // The following CommonMark: // | abc | def | // |---|---| // | cde| ddd| @@ -17307,7 +17365,7 @@ namespace Markdig.Tests // // - Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 22, "Extensions Pipe Table"); + Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 24, "Extensions Pipe Table"); TestParser.TestSpec("| abc | def | \n|---|---|\n| cde| ddd| \n| eee| fff|\n| fff | fffff | \n|gggg | ffff | ", "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
abcdef
cdeddd
eeefff
ffffffff
ggggffff
", "pipetables|advanced"); } } @@ -17318,9 +17376,9 @@ namespace Markdig.Tests public partial class TestExtensionsPipeTable { [Test] - public void Example023() + public void Example025() { - // Example 23 + // Example 25 // Section: Extensions Pipe Table // // The following CommonMark: @@ -17346,7 +17404,7 @@ namespace Markdig.Tests // // - Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 23, "Extensions Pipe Table"); + Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 25, "Extensions Pipe Table"); TestParser.TestSpec("a | b\n-- | - \n0 | 1 | 2", "\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ab
012
", "pipetables|advanced"); } } @@ -18664,15 +18722,15 @@ namespace Markdig.Tests // Section: Extensions Emoji // // The following CommonMark: - // This is a sentance :ok_hand: + // This is a sentence :ok_hand: // and keeps going to the next line :) // // Should be rendered as: - //

This is a sentance 👌 + //

This is a sentence 👌 // and keeps going to the next line 😃

Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 4, "Extensions Emoji"); - TestParser.TestSpec("This is a sentance :ok_hand:\nand keeps going to the next line :)", "

This is a sentance 👌\nand keeps going to the next line 😃

", "emojis|advanced+emojis"); + TestParser.TestSpec("This is a sentence :ok_hand:\nand keeps going to the next line :)", "

This is a sentence 👌\nand keeps going to the next line 😃

", "emojis|advanced+emojis"); } } // # Extensions @@ -20361,6 +20419,49 @@ namespace Markdig.Tests Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 1, "Extensions Mermaid diagrams"); TestParser.TestSpec("```mermaid\ngraph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;\n```", "
graph TD;\n A-->B;\n A-->C;\n B-->D;\n C-->D;\n
", "diagrams|advanced"); } + } + // ## nomnoml diagrams + // + // Using a fenced code block with the `nomnoml` language info will output a `
` instead of a `pre/code` block: + [TestFixture] + public partial class TestExtensionsnomnomldiagrams + { + [Test] + public void Example002() + { + // Example 2 + // Section: Extensions nomnoml diagrams + // + // The following CommonMark: + // ```nomnoml + // [example| + // propertyA: Int + // propertyB: string + // | + // methodA() + // methodB() + // | + // [subA]--[subB] + // [subA]-:>[sub C] + // ] + // ``` + // + // Should be rendered as: + //
[example| + // propertyA: Int + // propertyB: string + // | + // methodA() + // methodB() + // | + // [subA]--[subB] + // [subA]-:>[sub C] + // ] + //
+ + Console.WriteLine("Example {0}" + Environment.NewLine + "Section: {0}" + Environment.NewLine, 2, "Extensions nomnoml diagrams"); + TestParser.TestSpec("```nomnoml\n[example|\n propertyA: Int\n propertyB: string\n|\n methodA()\n methodB()\n|\n [subA]--[subB]\n [subA]-:>[sub C]\n]\n```", "
[example|\n propertyA: Int\n propertyB: string\n|\n methodA()\n methodB()\n|\n [subA]--[subB]\n [subA]-:>[sub C]\n]\n
", "diagrams|advanced"); + } } // TODO: Add other text diagram languages // # Extensions diff --git a/src/Markdig.Tests/Specs/Specs.tt b/src/Markdig.Tests/Specs/Specs.tt index 86671206..1ffe3e98 100644 --- a/src/Markdig.Tests/Specs/Specs.tt +++ b/src/Markdig.Tests/Specs/Specs.tt @@ -1,4 +1,4 @@ -<#/* +<#/* Copyright (c) Alexandre Mutel. All rights reserved. This file is licensed under the BSD-Clause 2 license. See the license.txt file in the project root for more information.The MIT License (MIT) @@ -36,7 +36,8 @@ SOFTWARE. <#@ import namespace="System.Collections.Generic" #> <#@ import namespace="System.CodeDom" #> <#@ import namespace="System.CodeDom.Compiler" #> -<#@ output extension=".cs" #><# +<#@ output extension=".cs" encoding="utf-8"#> +<# var specFiles = new KeyValuePair[] { new KeyValuePair("https://raw.githubusercontent.com/jgm/CommonMark/4ec06917c3a3632be4a935ffa0973092bd2621be/spec.txt", string.Empty), // 0.28 new KeyValuePair(Host.ResolvePath("PipeTableSpecs.md"), "pipetables|advanced"), diff --git a/src/Markdig/Extensions/Tables/HtmlTableRenderer.cs b/src/Markdig/Extensions/Tables/HtmlTableRenderer.cs index 2804d02f..5c32b0cf 100644 --- a/src/Markdig/Extensions/Tables/HtmlTableRenderer.cs +++ b/src/Markdig/Extensions/Tables/HtmlTableRenderer.cs @@ -85,7 +85,7 @@ namespace Markdig.Extensions.Tables { renderer.Write($" rowspan=\"{cell.RowSpan}\""); } - if (table.ColumnDefinitions != null) + if (table.ColumnDefinitions.Count > 0) { var columnIndex = cell.ColumnIndex < 0 || cell.ColumnIndex >= table.ColumnDefinitions.Count ? i diff --git a/src/Markdig/Extensions/Tables/PipeTableOptions.cs b/src/Markdig/Extensions/Tables/PipeTableOptions.cs index dc8058f0..01a6c733 100644 --- a/src/Markdig/Extensions/Tables/PipeTableOptions.cs +++ b/src/Markdig/Extensions/Tables/PipeTableOptions.cs @@ -1,4 +1,4 @@ -// Copyright (c) Alexandre Mutel. All rights reserved. +// Copyright (c) Alexandre Mutel. All rights reserved. // This file is licensed under the BSD-Clause 2 license. // See the license.txt file in the project root for more information. namespace Markdig.Extensions.Tables diff --git a/src/Markdig/Extensions/Tables/PipeTableParser.cs b/src/Markdig/Extensions/Tables/PipeTableParser.cs index 9397e845..06356e00 100644 --- a/src/Markdig/Extensions/Tables/PipeTableParser.cs +++ b/src/Markdig/Extensions/Tables/PipeTableParser.cs @@ -440,12 +440,13 @@ namespace Markdig.Extensions.Tables // If we have a header row, we can remove it // TODO: we could optimize this by merging FindHeaderRow and the previous loop + var tableRow = (TableRow)table[0]; + tableRow.IsHeader = Options.RequireHeaderSeparator; if (aligns != null) { - table.RemoveAt(1); - var tableRow = (TableRow) table[0]; - table.ColumnDefinitions.AddRange(aligns); tableRow.IsHeader = true; + table.RemoveAt(1); + table.ColumnDefinitions.AddRange(aligns); } // Perform delimiter processor that are coming after this processor @@ -532,6 +533,13 @@ namespace Markdig.Extensions.Tables ? columnDelimiter.FirstChild : delimiter.NextSibling; + // If there is no content after + if (IsNullOrSpace(nextSibling)) + { + isValidRow = true; + break; + } + if (!ParseHeaderString(nextSibling, out align)) { break; @@ -606,6 +614,20 @@ namespace Markdig.Extensions.Tables } } + private static bool IsNullOrSpace(Inline inline) + { + if (inline == null) + { + return true; + } + var literal = inline as LiteralInline; + if (literal != null) + { + return literal.Content.IsEmptyOrWhitespace(); + } + return false; + } + private class TableState { public TableState() diff --git a/src/Markdig/Extensions/Tables/Table.cs b/src/Markdig/Extensions/Tables/Table.cs index 121ba8ab..9ec8cd84 100644 --- a/src/Markdig/Extensions/Tables/Table.cs +++ b/src/Markdig/Extensions/Tables/Table.cs @@ -33,7 +33,7 @@ namespace Markdig.Extensions.Tables /// /// Gets or sets the column alignments. May be null. /// - public List ColumnDefinitions { get; private set; } + public List ColumnDefinitions { get; } /// /// Checks if the table structure is valid. From d7fd04d14ce55f57e1767f401144ecf04de0f204 Mon Sep 17 00:00:00 2001 From: Alexandre Mutel Date: Tue, 17 Oct 2017 23:01:26 +0200 Subject: [PATCH 9/9] Bump to 0.13.4 --- src/Markdig/Markdig.csproj | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/src/Markdig/Markdig.csproj b/src/Markdig/Markdig.csproj index a821d307..5cdbd671 100644 --- a/src/Markdig/Markdig.csproj +++ b/src/Markdig/Markdig.csproj @@ -5,7 +5,7 @@ Alexandre Mutel Markdig en-US - 0.13.3 + 0.13.4 Alexandre Mutel net35;net40;portable40-net40+sl5+win8+wp8+wpa81;netstandard1.1;uap10.0 Markdig @@ -13,14 +13,17 @@ Markdig.Signed Markdown CommonMark md html md2html - > 0.13.3 - - Add support for Pandoc YAML frontmatter (#138) - > 0.13.2 - - Add support for UAP10.0 (#137) - > 0.13.1 - - Fix indenting issue after a double digit list block using a tab (#134) - > 0.13.0 - - Update to latest CommonMark specs 0.28 +> 0.13.4 +- Add support for single table header row without a table body rows (#141) +- ADd support for `nomnoml` diagrams +> 0.13.3 +- Add support for Pandoc YAML frontmatter (#138) +> 0.13.2 +- Add support for UAP10.0 (#137) +> 0.13.1 +- Fix indenting issue after a double digit list block using a tab (#134) +> 0.13.0 +- Update to latest CommonMark specs 0.28 https://raw.githubusercontent.com/lunet-io/markdig/master/img/markdig.png https://github.com/lunet-io/markdig