Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AutoLinkTypes docs theme setting is slightly confusing #95

Open
CharliePoole opened this issue Aug 5, 2020 · 0 comments
Open

AutoLinkTypes docs theme setting is slightly confusing #95

CharliePoole opened this issue Aug 5, 2020 · 0 comments

Comments

@CharliePoole
Copy link

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant