ghwikipp icon indicating copy to clipboard operation
ghwikipp copied to clipboard

header -> wiki sync does not work correctly with Markdown links

Open MrOnlineCoder opened this issue 11 months ago • 2 comments

For some reason, when header -> wiki sync is done, markdown links in format of [link title](link URL) in descriptions are double wrapped and in result, rendered incorrectly in the wiki page.

Examples:

https://github.com/libsdl-org/sdlwiki/commit/161708930d6e160087459bc1165cbc8f1b8dc8b7

https://github.com/libsdl-org/sdlwiki/commit/0d05439450e4d1e2c7b62195af6f2a7c3bd32e78

Is this intended behaviour or I am missing something?

MrOnlineCoder avatar Jan 31 '25 01:01 MrOnlineCoder

It automatically generates links in the wiki when it sees a symbol that starts with SDLNet_ (or SDL_ in SDL itself, IMG_ in SDL_image, etc), and removes those links when moving back to the headers, so you don't have to manually link it (and shouldn't).

icculus avatar Jan 31 '25 18:01 icculus

@icculus I see, the edge case I am talking about is for example SDL_shadercross (https://github.com/libsdl-org/sdlwiki/commit/0d05439450e4d1e2c7b62195af6f2a7c3bd32e78). It starts with SDL_, but it's not actually a symbol, it should be a link to a repository! How then we can add it without confusing the parser, and still being able to create such links in descriptions or remarks? This may also apply if you put a link to SDL_net, SDL_image, SDL_ttf, etc...

MrOnlineCoder avatar Jan 31 '25 18:01 MrOnlineCoder

This was just fixed (it's a wikiheaders.pl issue, not ghwikipp, fwiw) ... https://github.com/libsdl-org/SDL/commit/5b688514c754fc7f91c676bc75e923f58f576b5c

icculus avatar Aug 28 '25 02:08 icculus