Update emoji support

* Add constants for emojis
* Move emoji shortcode rendering to Markup
* Add documentation
* Add example
* Add tests

docs/Docs.csproj

@@ -22,11 +22,23 @@
     </None>
   </ItemGroup>
 
+  <ItemGroup>
+    <None Remove="src\Data\emojis.json" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <EmbeddedResource Include="src\Data\emojis.json" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Statiq.Web" Version="1.0.0-beta.5" />
     <PackageReference Include="MinVer" PrivateAssets="All" Version="2.3.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Folder Include="input\assets\images\emojis\" />
+  </ItemGroup>
+
   <Target Name="Versioning" BeforeTargets="MinVer">
     <PropertyGroup Label="Build">
       <MinVerDefaultPreReleasePhase>preview</MinVerDefaultPreReleasePhase>

docs/Program.cs

@@ -19,6 +19,7 @@ namespace Docs
                 .ConfigureDeployment(deployBranch: "docs")
                 .AddShortcode("Children", typeof(ChildrenShortcode))
                 .AddShortcode("ColorTable", typeof(ColorTableShortcode))
+                .AddShortcode("EmojiTable", typeof(EmojiTableShortcode))
                 .AddPipelines()
                 .RunAsync();
 

docs/input/_layout.cshtml

@@ -128,14 +128,28 @@
                                         {
                                             IDocument root = OutputPages["index.html"].First();
                                             <div class="sidebar-nav-item @(Document.IdEquals(root) ? "active" : null)">
-                                                @Html.DocumentLink(root)
+                                                    @if(root.ShowLink())
+                                                    {
+                                                        @Html.DocumentLink(root)
+                                                    }
+                                                    else
+                                                    {
+                                                        @root.GetTitle()
+                                                    } 
                                             </div>
 
                                             @foreach (IDocument document in OutputPages.GetChildrenOf(root).OnlyVisible())
                                             {
                                                 DocumentList<IDocument> documentChildren = OutputPages.GetChildrenOf(document);
                                                 <div class="sidebar-nav-item @(Document.IdEquals(document) ? "active" : null) @(documentChildren.Any() ? "has-children" : null)">
-                                                    @Html.DocumentLink(document)
+                                                    @if(document.ShowLink())
+                                                    {
+                                                        @Html.DocumentLink(document)
+                                                    }
+                                                    else
+                                                    {
+                                                        @document.GetTitle()
+                                                    }                                                   
                                                 </div>
 
                                                 @if (documentChildren.OnlyVisible().Any())

docs/input/appendix/emojis.md

@@ -0,0 +1,38 @@
+Title: Emojis
+Order: 3
+---
+
+Please note that what emojis that can be used is completely up to 
+the operating system and/or terminal you're using, and no guarantees
+can be made of how it will look. Calculating the width of emojis
+is also not an exact science in many ways, so milage might vary when
+used in tables, panels or grids.
+
+To ensure best compatibility, consider only using emojis introduced
+before Unicode 13.0 that belongs in the `Emoji_Presentation` category
+in the official emoji list at 
+https://www.unicode.org/Public/UCD/latest/ucd/emoji/emoji-data.txt
+
+# Usage
+
+```csharp
+// Markup
+AnsiConsole.MarkupLine("Hello :globe_showing_europe_africa:!");
+
+// Constant
+var hello = "Hello " + Emoji.Known.GlobeShowingEuropeAfrica;
+```
+
+# Replacing emojis in text
+
+```csharp
+var phrase = "Mmmm :birthday_cake:";
+var rendered = Emoji.Replace(phrase);
+```
+
+# Emojis
+
+_The images in the table below might not render correctly in your 
+browser for the same reasons mentioned in the `Compatibility` section._
+
+<?# EmojiTable /?>

docs/input/appendix/index.md

@@ -1,3 +1,10 @@
 Title: Appendix
 Order: 10
----
+---
+
+# Sections
+
+* [Styles](xref:styles)
+* [Colors](xref:colors)
+* [Borders](xref:borders)
+* [Emojis](xref:emojis)

docs/input/markup.md

@@ -2,8 +2,7 @@ Title: Markup
 Order: 2
 ---
 
-In `Spectre.Console` there's a class called `Markup` that
-allows you to output rich text to the console.
+The class `Markup` allows you to output rich text to the console.
 
 # Syntax
 
@@ -54,6 +53,16 @@ You can set the background color in markup by prefixing the color with
 [default on blue]World[/]
 ```
 
+# Rendering emojis
+
+To output an emoji as part of markup, you can use emoji shortcodes.
+
+```csharp
+AnsiConsole.MarkupLine("Hello :globe_showing_europe_africa:!");
+```
+
+For a list of emoji, see the [Emojis](xref:styles) appendix section.
+
 # Colors
 
 For a list of colors, see the [Colors](xref:colors) appendix section.

docs/src/Constants.cs

@@ -1,14 +1,20 @@
-namespace Docs
+namespace Docs
 {
     public static class Constants
     {
         public const string NoContainer = nameof(NoContainer);
         public const string NoSidebar = nameof(NoSidebar);
+        public const string NoLink = nameof(NoLink);
         public const string Topic = nameof(Topic);
         public const string EditLink = nameof(EditLink);
         public const string Description = nameof(Description);
         public const string Hidden = nameof(Hidden);
 
+        public static class Emojis
+        {
+            public const string Root = "EMOJIS_ROOT";
+        }
+
         public static class Colors
         {
             public const string Url = "https://raw.githubusercontent.com/spectresystems/spectre.console/main/resources/scripts/Generator/Data/colors.json";

docs/src/Extensions/DocumentExtensions.cs

@@ -1,4 +1,4 @@
-using Statiq.Common;
+using Statiq.Common;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -16,6 +16,11 @@ namespace Docs
             return !document.GetBool(Constants.Hidden, false);
         }
 
+        public static bool ShowLink(this IDocument document)
+        {
+            return !document.GetBool(Constants.NoLink, false);
+        }
+
         public static IEnumerable<IDocument> OnlyVisible(this IEnumerable<IDocument> source)
         {
             return source.Where(x => x.IsVisible());

docs/src/Models/Emoji.cs

@@ -0,0 +1,20 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace Docs.Models
+{
+    public sealed class Emoji
+    {
+        public string Id { get; set; }
+        public string Name { get; set; }
+        public string Description { get; set; }
+        public string Code { get; set; }
+
+        public static List<Emoji> Parse(string json)
+        {
+            return JsonConvert.DeserializeObject<List<Emoji>>(json);
+        }
+    }
+}

docs/src/Modules/ReadEmbedded.cs

@@ -0,0 +1,41 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Threading.Tasks;
+using Statiq.Common;
+
+namespace Docs.Modules
+{
+    public sealed class ReadEmbedded : Module
+    {
+        private readonly System.Reflection.Assembly _assembly;
+        private readonly string _resource;
+
+        public ReadEmbedded(System.Reflection.Assembly assembly, string resource)
+        {
+            _assembly = assembly ?? throw new ArgumentNullException(nameof(assembly));
+            _resource = resource ?? throw new ArgumentNullException(nameof(resource));
+        }
+
+        protected override Task<IEnumerable<IDocument>> ExecuteContextAsync(IExecutionContext context)
+        {
+            return Task.FromResult((IEnumerable<IDocument>)new[]
+            {
+                context.CreateDocument(ReadResource()),
+            });
+        }
+
+        private Stream ReadResource()
+        {
+            var resourceName = _resource.Replace("/", ".");
+
+            var stream = _assembly.GetManifestResourceStream(resourceName);
+            if (stream == null)
+            {
+                throw new InvalidOperationException("Could not load manifest resource stream.");
+            }
+
+            return stream;
+        }
+    }
+}

docs/src/Pipelines/ColorsPipeline.cs

@@ -26,13 +26,8 @@ namespace Docs.Pipelines
                 new ExecuteConfig(
                     Config.FromDocument(async (doc, ctx) =>
                     {
-                        var colors = Color.Parse(await doc.GetContentStringAsync()).ToList(); 
-                        var definitions = new List<IDocument> { colors.ToDocument(Constants.Colors.Root) };
-
-                        return doc.Clone(new MetadataDictionary
-                        {
-                            [Constants.Colors.Root] = definitions
-                        });
+                        var data = Color.Parse(await doc.GetContentStringAsync()).ToList(); 
+                        return data.ToDocument(Constants.Colors.Root);
                     }))
             };
         }

docs/src/Pipelines/EmojiPipeline.cs

@@ -0,0 +1,34 @@
+using System.Collections.Generic;
+using Docs.Models;
+using Docs.Modules;
+using Statiq.Common;
+using Statiq.Core;
+
+namespace Docs.Pipelines
+{
+    public class EmojiPipeline : Pipeline
+    {
+        public EmojiPipeline()
+        {
+            InputModules = new ModuleList
+            {
+                new ExecuteConfig(
+                    Config.FromContext(ctx => {
+                        return new ReadEmbedded(
+                            typeof(EmojiPipeline).Assembly,
+                            "Docs/src/Data/emojis.json");
+                    }))
+            };
+
+            ProcessModules = new ModuleList
+            {
+                new ExecuteConfig(
+                    Config.FromDocument(async (doc, ctx) =>
+                    {
+                        var data = Emoji.Parse(await doc.GetContentStringAsync());
+                        return data.ToDocument(Constants.Emojis.Root);
+                    }))
+            };
+        }
+    }
+}

docs/src/Shortcodes/ColorTableShortcode.cs

@@ -17,11 +17,10 @@ namespace Docs.Shortcodes
             // Get the definition.
             var colors = context.Outputs
                 .FromPipeline(nameof(ColorsPipeline))
-                .First()
-                .GetChildren(Constants.Colors.Root)
                 .OfType<ObjectDocument<List<Color>>>()
                 .First().Object;
 
+            // Headers
             var table = new XElement("table", new XAttribute("class", "table"));
             var header = new XElement("tr", new XAttribute("class", "color-row"));
             header.Add(new XElement("th", ""));

docs/src/Shortcodes/EmojiTableShortcode.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Statiq.Common;
+using System.Xml.Linq;
+using Docs.Pipelines;
+using Docs.Models;
+
+namespace Docs.Shortcodes
+{
+    public class EmojiTableShortcode : SyncShortcode
+    {
+        public override ShortcodeResult Execute(KeyValuePair<string, string>[] args, string content, IDocument document, IExecutionContext context)
+        {
+            var emojis = context.Outputs
+                .FromPipeline(nameof(EmojiPipeline))
+                .OfType<ObjectDocument<List<Emoji>>>()
+                .First().Object;
+
+            // Headers
+            var table = new XElement("table", new XAttribute("class", "table"));
+            var header = new XElement("tr", new XAttribute("class", "emoji-row"));
+            header.Add(new XElement("th", ""));
+            header.Add(new XElement("th", "Markup"));
+            header.Add(new XElement("th", "Constant"));
+            table.Add(header);
+
+            foreach (var emoji in emojis)
+            {
+                var code = emoji.Code.Replace("U+0000", "U+").Replace("U+000", "U+");
+                var icon = string.Format("&#x{0};", emoji.Code.Replace("U+", string.Empty));
+
+                var row = new XElement("tr");
+                row.Add(new XElement("td", icon));
+                row.Add(new XElement("td", new XElement("code", $":{emoji.Id}:")));
+                row.Add(new XElement("td", new XElement("code", emoji.Name)));
+
+                table.Add(row);
+            }
+
+            return table.ToString()
+                .Replace("&amp;#x", "&#x");
+        }
+    }
+}