AutoLinkTypes docs theme setting is slightly confusing

[savornicesei]

Issue by CharliePoole
Wednesday Aug 05, 2020 at 14:54 GMT
Originally opened as Wyamio/Wyam.Web#95

---

At https://wyam.io/recipes/docs/settings in the documentation the entry for DocsKeys.AutoLinkTypes says...

Controls whether type names from the API enclosed in code fences in either blog posts or content pages should be automatically linked to the corresponding API documentation page (the default is true).

It took me quite a bit of time experimenting to figure out why this wasn't working for me. Reading the code and learning that it actually looks for a <code> element in the html put me on track finally.

I eventually learned through experimentation that the following generate a link in a .md file...

• Simple class Name between back-ticks
• Full code fence (three ticks before and after) without any language specification

The following don't work, even though the documentation led me to try them

• Anything more than the simple class Name (code samples, FullName of class, class plus method name)
• Use of a code fence with a language specified

I understand that you are not updating Wyam these days but an update to the docs would be nice. If I read the code correctly, however, the info on that particular page is pulled from the Wyam code itself. Would you accept a PR to fix it?

AB#22

[savornicesei]

Fixed in ed1c454