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

fix: improve markdown render with CRLF #1953

Merged
merged 1 commit into from
Apr 27, 2022
Merged

Conversation

AlexVarchuk
Copy link
Collaborator

What/Why/How?

fixes: #1952.
In #1845 we improve our build heading regex but not include all CRLF symbols. This PR should fix it.

Reference

Testing

{
  "openapi": "3.0.1",
  "info": {
    "title": "Minimal Example JSON",
    "description": "# Getting Started\r\n## Authentication\r\nAll API Requests _must_ contain an Authorization Header with a valid access token",
    "contact": {
      "name": "Name",
      "email": "email@example.com"
    },
    "version": "v3.0: 3.10.0.0"
  }
}

Screenshots (optional)

Before
Screenshot 2022-03-31 at 11 48 03

After
Screenshot 2022-03-31 at 11 47 43

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

@AlexVarchuk AlexVarchuk self-assigned this Mar 31, 2022
@AlexVarchuk AlexVarchuk requested a review from Oprysk March 31, 2022 08:49
@AlexVarchuk AlexVarchuk merged commit aba2d1a into master Apr 27, 2022
@AlexVarchuk AlexVarchuk deleted the fix/markdown-header branch April 27, 2022 08:19
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.

Markdown headers render weird when CRLF is used in OpenAPI description json
2 participants