Fix inline code in left navigation and h1 rendering

[reakaleek]

Closes #235
Closes #311

[Mpdreamz]

Small nitpicks other than that it LGTM!

[Mpdreamz]

Strip once when setting instead of each time we get the property.

[reakaleek]

7bb6322

[Mpdreamz]

I'm partial to making these extension methods.

Suggested change

	public static class Markdown
	{
	public static string StripMarkdown(string markdown)
	public static string class MarkdownStringExtensions
	{
	public static string StripMarkdown(this string markdown)

[reakaleek]

4ddc4bb

[Mpdreamz]

Suggested change

	return string.IsNullOrEmpty(title) ? null : Helpers.Markdown.StripMarkdown(title);
	return string.IsNullOrEmpty(title) ? null : title.StripMarkdown();

[reakaleek]

4ddc4bb

[Mpdreamz]

Maybe introduce a TitleRaw property thats the markdown so that we can assume Title and NavigationTitle are sanitized.

Then when rendering we can use TitleRaw

[reakaleek]

7bb6322

[reakaleek]

I'm a bit unsure about this. This caused changes in various places, where it's not entirely clear to me if it expects a raw markdown string or sanitized title.

Was the assumption that it's only a sanitized title during the first implementations?

[Mpdreamz]

See my comment here: https://github.com/elastic/docs-builder/pull/290/files#r1927019403

[reakaleek]

e00d555

[Mpdreamz]

For funsies tried to see if pooling the StringBuilder() this instantatiates each time had an impact but its very minimal:

private static readonly ObjectPool<StringBuilder> StringBuilderPool = new DefaultObjectPool<StringBuilder>(new StringBuilderPooledObjectPolicy());
public static string StripMarkdownPooled(string markdown)
{
   	var sb = StringBuilderPool.Get();
	try
	{
		using var writer = new StringWriter(sb, CultureInfo.InvariantCulture);
		Markdig.Markdown.ToPlainText(markdown, writer);
		return writer.ToString().TrimEnd('\n');
	}
	finally
	{
		StringBuilderPool.Return(sb);
	}
}

Method	Mean	Error	Gen0	Gen1	Allocated
StripMarkdown	1.963 us	NA	0.4829	0.0029	3.95 KB
StripMarkdownPooled	1.706 us	NA	0.4435	0.0027	3.63 KB

[reakaleek]

Oh interesting, thank you!

How did you actually measure this?

[Mpdreamz]

Benchmark dot Will add a general benchmarking project at some point in the next week so we can utilize this more.

and: https://www.elastic.co/guide/en/ecs-logging/dotnet/current/benchmark-dotnet-data-shipper.html on CI 😄

[Mpdreamz]

I meant it reverse e.g:

Title is the sanitized version.

public string TitleRaw { get; private set; }

public string? Title
{
    get => _title;
    private set
    {
        _title = value?.StripMarkdown();
        TitleRaw = value;
    }
}

That way the change is not that pervasive, the only place we need access to the markdown is in the rendering slice.

[reakaleek]

OK. I think I got it right now.

e00d555

[bmorelli25]

Looks good!