zostay / RakuWAPI

The Web API for Raku (RakuWAPI)
Artistic License 2.0
24 stars 5 forks source link

Fix links generated in README.md on github #6

Closed zostay closed 9 years ago

zostay commented 9 years ago

@claar has reported that most of the links in the README.md are broken. They were automatically generated by Pod::To::Markdown. Most of the broken links ought to point at documents on doc.perl6.org.

I can fix this either with some text munging, which I already do to fix the code-tags in the environment able, or I may need to patch Pod::To::Markdown, which needs quite a bit of work anyway (as just mentioned, it doesn't properly handle code-tags in tables).

zostay commented 9 years ago

I have fixed the links and the rest of the formatting. I solved this the cheap way rather than the best way. I have created a small script that post-processes the Markdown generated by Pod::To::Markdown to fix links, fix tags that are not correctly handled within tables, applies github's markdown extension for syntax highlighting the code blocks, etc.

Now, I just have to run make whenever I modify the P6SGI.pod. Probably, I should add a git hook to do that for me automatically or some such.