Global Properties in Markdown or Mustaching Markdown 🥸

[VaclavElias]

I have got this looong path in many places in our *.md files (these are not templates!) and I don't fancy that path being hard-coded.

## Code

[!code-csharp[Entity](../../../../stride/samples/Tutorials/CSharpBeginner/CSharpBeginner/CSharpBeginner.Game/Code/GettingTheEntityDemo.cs)]

Maybe I would like this version with _strideLocalPath (remote GitHub link would be also nice in some cases)

## My lovely path

{{_strideLocalPath}}

{{#_names}}
  	<p>Name: {{.}}</p>
{{/_names}}

## Code

[!code-csharp[Entity]({{_strideLocalPath}}/GettingTheEntityDemo.cs)]

The property is defined in docfx.json

    "globalMetadata": {
      "_appTitle": "Stride Docs",
      "_enableSearch": true,
      "_appLogoPath": "media/stride-logo-red.svg",
      "_strideLocalPath": "../../../../stride/samples/Tutorials/CSharpBeginner/CSharpBeginner/CSharpBeginner.Game/Code",
      "_names": [ "vicancy", "yufeih" ]
    },

And this is the result, including other mustache goodies, like a loop 🙂

At the moment it is not possible, unless 🤩 I add this code to BuildConceptualDocument.cs.

⚠️Note: This is just my test implementation. You are going to know the best how it should be done..

Not sure, if this is the right place, also the consequences. Maybe it would be better to add opt-in option for Mustache preprocessing in the file .md yaml header.

var stubble = new StubbleBuilder().Build();
var mustachedMarkdown = stubble.Render(markdown, content);

if (markdown != mustachedMarkdown)
{
    Logger.LogWarning($"Mustache applied for {model.File}");

    markdown = mustachedMarkdown;
}

What are you thoughts on this?

[yufeih]

The codeSourceBasePath config sets the base directory for the path specified in <code source="Example.cs">

[VaclavElias]

If I used codeSourceBasePath, then I don't have to use the long path in this file? I think you might be referring to use codeSourceBasePath in some other scenarios?

https://github.com/VaclavElias/stride-docs-next/blob/main/en/tutorials/csharpbeginner/delta-time.md?plain=1