🐛💄 `frontmatter` not properly handled by `typedoc`

[lukas-runge]

Basically this just concerns README.md. All other files are not integrated into typedoc anyways. This file needs to have frontmatter for mdsvex for the endeavour in #15 to work out. 🔥😇

Typedoc should just ignore frontmatter - currently it is shown like so:

[hrueger]

We could either create an issue in the typedoc repo, try to fix it there ourselves and make a PR or - as more of a quick fix - remove that before building the docs (in the gh action) using a regex. What do you prefer?

[lukas-runge]

As we use the typedoc --watch command for developing locally I would prefer fixing it in there. I haven't looked at it in more detail tho, so I can't evaluate if thats a practical solution. If we find it impractical then the quick fix is fine too as it will get the job done for now. 👌

[hrueger]

OK, I did some research. According to their package.json it seems like typedoc is using marked as the markdown parser. They have a (closed) issue about yaml frontmatter here: https://github.com/markedjs/marked/issues/485 TLDR: won't be implemented, out of scope.

Should we create a new issue in the typedoc repo?

[lukas-runge]

@hrueger thank you for the research!

Yeah, let's create a new issue over in typedoc. This could be as easy as removing the frontmatter before parsing. This could be a feature enabled thru the typedoc.json. Let's see what they think. 👍

[hrueger]

Sure, see https://github.com/TypeStrong/typedoc/issues/2381

[hrueger]

fixed by https://github.com/TypeStrong/typedoc/issues/2381. Theme was also updated to support the new typedoc version in https://github.com/mengxinssfd/typedoc-theme/issues/3