Skip to content

[OpenAPI.next] validate (not lint) versions/3.*.md with mdv #992

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

Merged
merged 4 commits into from
Apr 26, 2017

Conversation

MikeRalphson
Copy link
Member

@MikeRalphson MikeRalphson commented Mar 14, 2017

Checks for broken links and images with missing alt tags and fenced code-blocks with no defined language.

This change also updates the Node.js version used on Travis from 0.10.36 (which is now unsupported) to a LTS version (6.x)

Issues identified have been fixed.

@webron
Copy link
Member

webron commented Mar 14, 2017

I don't know how, but it looks like a bunch of things got messed up when you look at the rendered view.
For example:

@webron
Copy link
Member

webron commented Mar 14, 2017

Can the check to add ```text be configured and removed? It's not really needed and just adds noise.

@MikeRalphson
Copy link
Member Author

@webron thanks for the heads-up. The raw diff looked ok. Will rework,

@MikeRalphson
Copy link
Member Author

MikeRalphson commented Mar 15, 2017

@webron commits reworked but table-formatting issues still remain.

My theory is that GitHub have recently changed their markdown renderer and the <span>&#124;</span> hack in table cells no-longer works.

You can see the same problem in an unrelated PR by @willdady here.

The following markdown

Column A|Column B|Column C|Overflow
---|---|---|---
Cell A|Cell <span>&#124;</span>B|Cell C

renders as:

Column A Column B Column C Overflow
Cell A Cell |B Cell C

One option is to use another Unicode bar character:

Column A Column B Column C Overflow
Cell A Cell ¦B Cell C

Or escaping as per the GFM spec:

Column A Column B Column C Overflow
Cell A Cell |B Cell C

I suspect the 'published' versions/3.0.md at RC0 is showing cached html from before the change.

@webron
Copy link
Member

webron commented Mar 15, 2017

Thanks. I'll look into it.

@MikeRalphson MikeRalphson changed the title [OpenAPI.next] validate (not lint) versions/3.0.md with mdv [OpenAPI.next] validate (not lint) versions/3.*.md with mdv Mar 16, 2017
@webron
Copy link
Member

webron commented Mar 27, 2017

@MikeRalphson - I should have merged the PRs in a different order, but alas... I'm trying to manually resolve issues for some PRs but would you mind resolving these yourself?

@webron
Copy link
Member

webron commented Mar 27, 2017

@MikeRalphson I see you're pushing changes, lmk when done.

@MikeRalphson
Copy link
Member Author

@webron those four conflicts (between fixed links and fixed table formatting) are resolved.

@webron webron merged commit c3cea4e into OAI:OpenAPI.next Apr 26, 2017
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.

3 participants