search

adlnet / xAPI-Spec

The xAPI Specification describes communication about learner activity and experiences between technologies.
https://adlnet.gov/projects/xapi/
907 stars 404 forks source link

MD formatting issues in sections 2.4.11, 2.5, 2.6 #1033

Closed creighton closed 7 years ago

creighton commented 7 years ago

https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md#attachments

The markdown seems messed up in the sections around the Attachments section

garemoko commented 7 years ago

These seem to be caused by self closing anchor tags with no closing image

There's another instance in the statement immutability section and other documents are affected too (e.g. the main title of part 3).

We did address this before but it looks like the extra links for the test suite broke new things. Looking back over historical versions, it looks like this was broken for a while. I wonder if github updated something in their html version or something to make these tags invalid.

It does look quite bad; I don't really want to wait for the next release to fix this in master.

garemoko commented 7 years ago

Yeh, here's a google cache version of the page from march 16th: http://webcache.googleusercontent.com/search?q=cache:https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Data.md

All looks good. I can't see what's different, but clearly Github changed something that's causing this bad html to be an issue.

garemoko commented 7 years ago

There's the problem: https://github.com/blog/2333-a-formal-spec-for-github-flavored-markdown

https://githubengineering.com/a-formal-spec-for-github-markdown/