Skip to content

feat(Docs): Markdown support in Parameters descriptions #1329

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
May 26, 2021
Merged

feat(Docs): Markdown support in Parameters descriptions #1329

merged 5 commits into from
May 26, 2021

Conversation

@mmiask
Copy link
Contributor

@mmiask mmiask commented May 25, 2021 •
edited
Loading

Resolves: #1092

Screenshot 2021-05-25 at 12 42 34

UPDATE: ⚠️ This does not apply to Response section It will after merging stoplightio/json-schema-viewer#146

@netlify
Copy link

netlify bot commented May 25, 2021 •
edited
Loading

Deploy Preview for stoplight-elements ready!

Built with commit 3eafcb8

https://deploy-preview-1329--stoplight-elements.netlify.app

@mmiask mmiask self-assigned this May 25, 2021
@netlify
Copy link

netlify bot commented May 25, 2021

Deploy Preview for stoplight-elements-demo ready!

Built with commit 8784402

https://deploy-preview-1329--stoplight-elements-demo.netlify.app

@mmiask mmiask marked this pull request as ready for review May 25, 2021 10:46
@mmiask mmiask requested a review from philsturgeon as a code owner May 25, 2021 10:46
@mmiask mmiask requested review from a team and mallachari May 25, 2021 10:46
@mmiask mmiask changed the title feat: make it work feat: Markdown support in Parameters descriptions May 25, 2021
@mmiask mmiask changed the title feat: Markdown support in Parameters descriptions feat(Docs): Markdown support in Parameters descriptions May 25, 2021
@netlify
Copy link

netlify bot commented May 25, 2021 •
edited
Loading

Deploy Preview for stoplight-elements-demo ready!

Built with commit 3eafcb8

https://deploy-preview-1329--stoplight-elements-demo.netlify.app

@philsturgeon
Copy link
Contributor

philsturgeon commented May 25, 2021

Does this cover JSV too?

@mmiask
Copy link
Contributor Author

mmiask commented May 25, 2021 •
edited
Loading

Does this cover JSV too?

@philsturgeon no, as JSV is not used for displaying operation parameters. I have a solution ready though, would you like me to push it as well?

@philsturgeon
Copy link
Contributor

philsturgeon commented May 25, 2021

Yeah please! The title was hinting at this: "JSV/Parameters: ..."

Bascially those two things look really similar and markdown should work in both of them, even though they're different code bases. The end users might be a bit confused that markdown works in one but not the other. :)

mallachari
mallachari approved these changes May 26, 2021
View reviewed changes
Copy link

@mallachari mallachari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works great!

@mmiask mmiask merged commit fcf7201 into main May 26, 2021
@mmiask mmiask deleted the feat/operation-parameters-description-markdown branch May 26, 2021 09:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@philsturgeon philsturgeon Awaiting requested review from philsturgeon

1 more reviewer

@mallachari mallachari mallachari approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@mmiask mmiask

Labels

team/undefined

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

JSV/Params: Markdown in parameter descriptions

4 participants

@mmiask @philsturgeon @mallachari