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

Fixed some Githubs's markdown rendering problems in part 2 of the documentation #1038

Closed
wants to merge 1 commit into from

Conversation

diegoreico
Copy link

There were some titles in the doc that had wrong spacing for Github's markdown rendering engine.

In the web browser everybody was seeing something like

### 2.5 Retrieval of Statements

Instead of

2.5 Retrieval of Statements

There were some titles in the doc that had wrong spacing for Github's markdown rendering engine
@garemoko
Copy link
Contributor

Thanks so much for your contribution. Github changed their markdown rending last week and it has broken a lot of documents, not just the xAPI spec.

The issues you're seeing can also be resolved by using correctly closed anchor tags, which I think is the better fix. There's already a PR that fixes all of the documents except contributing.md here: #1034

And another PR addressing contributing.md here: #1036

So, thanks again for your contribution, but in this case a fix is already in the works.

@andyjohnson
Copy link
Contributor

Hey Diego, I'm guessing these are covered in other merges (and there is just a discrepancy in number/style of return carriages). Let's wait on @aakoch as he had a couple merges and if yours haven't been addressed, could you work off the latest merge? Thanks!

@garemoko
Copy link
Contributor

Looks like the branch for this has now been deleted as it's now saying "unknown repository". We should probably just close this PR.

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

Successfully merging this pull request may close these issues.

None yet

3 participants