Wyamio / Wyam.Web

The website for the Wyam static content generator, generated by Wyam.
http://wyam.io
MIT License
40 stars 57 forks source link

AutoLinkTypes docs theme setting is slightly confusing #95

Open CharliePoole opened 4 years ago

CharliePoole commented 4 years ago

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...

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

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?