-
Notifications
You must be signed in to change notification settings - Fork 70
Fix Markdown syntax when using code in the link #159
Comments
When code is used in a link, the Markdown syntax with the pipe command no longer works. This commit fixes the Markdown files in which this occurs.
@trncb I would hold off on doing any work in this area. The site currently has an open PR to switch to a new markdown parsing/rendering engine, so I would suggest that any changes should be made after this is merged to prevent any unnecessary work. The markdown files are maintained in the |
Ok cool. Thanks for clarifying that @gep13. Will hold off on that |
@trncb the PR in question is this one... https://github.com/chocolatey/chocolatey.org/pull/715 |
@trncb @gep13 The PR specifically for the docs area is here (just pushed up this morning) https://github.com/chocolatey/chocolatey.org/pull/724. I did not realize this was an issue though and did not address it. These types of links are parsing correctly on chocolatey.org with this PR, but may need to look into this more to find a way to make those links parse correctly everywhere. What would be the correct syntax to make them parse correctly on wiki? |
Nice @designxsteph. You are correct, the parsing is correct on chocolatey.org. Regarding the parsing on wiki, what I thought was correct does not work, so have to do a bit more digging. |
On many of the Commands Reference pages, there are links in which the code syntax has been used (``). This breaks the Markdown syntax to dynamically link to the wiki pages referenced in the link, and appears as raw Markdown rather than being parsed correctly.
Example: [[
choco pack
|CommandsPack]]It should be trivial enough to run through the affected files and update these so that they show correctly on the wiki (which I will do anyway).
I am not sure on the next step, though. These files (eg. CommandsReference.md, CommandsInstall.md) state they are automatically generated from the choco repo, but they appear to have been manually edited over the last few months.
It might pay for this to be verified and (potentially) updated where the files are automatically generated.
The text was updated successfully, but these errors were encountered: