feat: added possibility to add a edit page

capjan · capjan · commit af05dc0dfda3 · 2022-09-03T15:19:07.000+02:00
diff --git a/Source/Markdown.Renderer.Test/RendererTest.cs b/Source/Markdown.Renderer.Test/RendererTest.cs
@@ -11,7 +11,7 @@ public async Task BasicTest()
         var renderer = new HtmlRenderer(); 
         var sb = new StringBuilder();
         using var sw = new StringWriter(sb);
-        await renderer.WriteHtml(sw, "test", "", 0, markdown);
+        await renderer.WriteHtml(sw, "test", "", 0, markdown, "");
         var renderedHtml = sb.ToString();
         
         Assert.NotEmpty(renderedHtml);
diff --git a/Source/Markdown.Renderer/HtmlRenderer.cs b/Source/Markdown.Renderer/HtmlRenderer.cs
@@ -39,7 +39,13 @@ public void PrepareBasePath(string basePath)
 
         WriteCssFileTo(cssFilePath);
     }
-    public async Task WriteHtml(TextWriter writer, string title, string description, int nestingDeep, string markdown)
+    public async Task WriteHtml(
+        TextWriter writer,
+        string title,
+        string description,
+        int nestingDeep,
+        string markdown,
+        string editPageLink)
     {
         var prefix = string.Concat(Enumerable.Repeat("../", nestingDeep));
         var cssFileLink = prefix + "css/main.css";
@@ -52,7 +58,8 @@ public async Task WriteHtml(TextWriter writer, string title, string description,
             Title = title,
             Description = description,
             RenderedMarkdown = renderedMarkdown,
-            CssLink = cssFileLink
+            CssLink = cssFileLink,
+            EditPageLink = editPageLink
         };
         
         var renderedHtml = await _engine.CompileRenderAsync("Markdown.Renderer.Res.Html.main.cshtml", model);
diff --git a/Source/Markdown.Renderer/Res/Html/main.cshtml b/Source/Markdown.Renderer/Res/Html/main.cshtml
@@ -13,5 +13,10 @@
 </head>
 <body>
 @Raw(@Model.RenderedMarkdown)
+@if (!string.IsNullOrEmpty(Model.EditPageLink))
+{
+<hr/>
+<a href="@Model.EditPageLink">✎ Edit Page</a>
+}
 </body>
 </html>
diff --git a/Source/Markdown.Renderer/Res/Model/MainModel.cs b/Source/Markdown.Renderer/Res/Model/MainModel.cs
@@ -5,5 +5,10 @@ public class MainModel
     public string Title { get; set; } = string.Empty;
     public string Description { get; set; } = string.Empty;
     public string RenderedMarkdown { get; set; } = string.Empty;
+    
+    /// <summary>
+    /// Hyperlink to the website that allows editing the current site
+    /// </summary>
+    public string EditPageLink { get; set; } = string.Empty;
     public string CssLink { get; set; } = string.Empty;
 }
diff --git a/Source/MarkdownUtil/Commands/RenderCommand.cs b/Source/MarkdownUtil/Commands/RenderCommand.cs
@@ -38,14 +38,14 @@ public override int Execute([NotNull] CommandContext context, [NotNull] RenderCo
         CopyAssets(rootPath, outPath, graph);
         
         AnsiConsole.WriteLine($"Rendering {nodeCount} Files");
-        RenderNodesToHtml(rootPath, outPath, graph);
+        RenderNodesToHtml(rootPath, outPath, graph, settings.EditPageRoot);
         
         return 0;
     }
 
-    private void RenderNodesToHtml(string rootPath, string outPath, MarkdownGraph graph)
+    private void RenderNodesToHtml(string rootPath, string outPath, MarkdownGraph graph, string editPageRoot)
     {
-        var rendererVisitor = new MarkdigVisitor(rootPath, outPath, _renderer);
+        var rendererVisitor = new MarkdigVisitor(rootPath, outPath, _renderer, editPageRoot);
         graph.Visit(rendererVisitor);
     }
 
diff --git a/Source/MarkdownUtil/Commands/Settings/RenderCommandSettings.cs b/Source/MarkdownUtil/Commands/Settings/RenderCommandSettings.cs
@@ -13,6 +13,11 @@ public sealed class RenderCommandSettings : CommandSettings, IVisitorSettings
     [CommandOption("--hidden")]
     [DefaultValue(true)]
     public bool IncludeHidden { get; init; }
+
+    [CommandOption("--editPageRoot")]
+    [Description("URL to the root url for editing the source files")]
+    [DefaultValue("")]
+    public string EditPageRoot { get; set; }
     
     [Description("Root/Home Path for the Index")]
     [CommandArgument(0, "[PATH]")]
diff --git a/Source/MarkdownUtil/Service/Visitors/MarkdigVisitor.cs b/Source/MarkdownUtil/Service/Visitors/MarkdigVisitor.cs
@@ -6,27 +6,38 @@ namespace MarkdownUtil.Service.Visitors;
 
 public class MarkdigVisitor : BaseVisitor
 {
-    public MarkdigVisitor(string rootPath, string outPath, HtmlRenderer htmlFoundation) : base(rootPath, outPath, ".html")
+    public MarkdigVisitor(
+        string rootPath, 
+        string outPath, 
+        HtmlRenderer htmlFoundation, 
+        string editPageRoot) : base(rootPath, outPath, ".html")
     {
         _htmlFoundation = htmlFoundation;
+        _editPageRoot = editPageRoot;
     }
     
     private readonly HtmlRenderer _htmlFoundation;
+    private readonly string _editPageRoot;
 
     protected override bool ProcessFile(MarkdownFile entity, int graphDepth, FilePathInfo io)
     {
         AnsiConsole.WriteLine($"{io.InputRelativeFilePathToRootDirectory} => {io.OutputRelativeFilePathToRootDirectory}");
 
         var markdown = io.ReadAllText();
-        io.CreateOutputDirectory();
-        io.DeleteOutputFileIfExists();
+        io.CreateOutputDirectory();    // ensures that the output directory exits
+        io.DeleteOutputFileIfExists(); // deletes old output file if it exits
 
+        var editPageLink = string.IsNullOrEmpty(_editPageRoot) ? string.Empty : Path.Combine(_editPageRoot, io.InputRelativeFilePathToRootDirectory);
+        
         var outputFileName = io.OutputFullFilePath;
+   
         if (outputFileName.EndsWith("readme.html", StringComparison.InvariantCultureIgnoreCase))
             outputFileName = outputFileName.Substring(0, outputFileName.Length - 11) + "index.html";
+        // Delete the Output file if it already exits
+        if (File.Exists(outputFileName)) File.Delete(outputFileName);
         using var fs = new FileStream(outputFileName, FileMode.CreateNew, FileAccess.Write);
         using var sw = new StreamWriter(fs);
-        _htmlFoundation.WriteHtml(sw, entity.Title, "", graphDepth, markdown).Wait();
+        _htmlFoundation.WriteHtml(sw, entity.Title, "", graphDepth, markdown, editPageLink).Wait();
         return true;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -38,14 +38,14 @@ public override int Execute([NotNull] CommandContext context, [NotNull] RenderCo`
`38`	`38`	`CopyAssets(rootPath, outPath, graph);`
`39`	`39`
`40`	`40`	`AnsiConsole.WriteLine($"Rendering {nodeCount} Files");`
`41`		`- RenderNodesToHtml(rootPath, outPath, graph);`
	`41`	`+ RenderNodesToHtml(rootPath, outPath, graph, settings.EditPageRoot);`
`42`	`42`
`43`	`43`	`return 0;`
`44`	`44`	`}`
`45`	`45`
`46`		`- private void RenderNodesToHtml(string rootPath, string outPath, MarkdownGraph graph)`
	`46`	`+ private void RenderNodesToHtml(string rootPath, string outPath, MarkdownGraph graph, string editPageRoot)`
`47`	`47`	`{`
`48`		`- var rendererVisitor = new MarkdigVisitor(rootPath, outPath, _renderer);`
	`48`	`+ var rendererVisitor = new MarkdigVisitor(rootPath, outPath, _renderer, editPageRoot);`
`49`	`49`	`graph.Visit(rendererVisitor);`
`50`	`50`	`}`
`51`	`51`