Repository navigation
v1.3.0
This release makes a few improvements to both the literal and rendered output. (#2)
- GitHub seems to have updated their
<p>styling to be less disruptive within a table cell. Previously, paragraphs would have too much margin/padding around them, misaligning them with non-paragraph content in adjacent cells. Now, paragraph content aligns with non-paragraph content.- To fix this, previously
graphql-markdownremoved all<p>tags and ensured multiple paragraphs were separated with<br>elements. - Now,
graphql-markdownstill removes<p>tags if the entire string is a single paragraph (to minimize their unnecessary presence in the output). However, if there are multiple paragraphs, or elements before/after the only paragraph, they will be maintained. This improves the rendering of cases such as lists (and various other non-paragraph elements) following paragraphs (previously, there was not enough whitespace between them).
- To fix this, previously
- The
markedrenderer is now called with{ gfm: true }. - The literal output of the rendered schema Markdown is now reformatted to wrap after 80 characters instead of maintaining the original source's line wrapping. This looks better because the original content was written in the context of its surrounding code and indentation level, so maintaining the original wrapping just looked wrong. This has no affect on the rendered output, just the literal output.