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

Add markdown support to example summary #690

Merged
merged 7 commits into from
Jan 9, 2024
Merged

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Jan 8, 2024

Description

Adds markdown remark and rehype support to request/response example/examples summary text, allowing rendering of GitHub-flavored markdown.

Note: also adds support for rendering Docusaurus-style CodeBlock

Motivation and Context

Enables users to include components such as markdown links, tables, code blocks, etc.

How Has This Been Tested?

Tested using the Petstore API.

Screenshots (if appropriate)

Screenshot 2024-01-08 at 8 20 05 AM

Types of changes

  • New feature (non-breaking change which adds functionality)

@sserrata sserrata added enhancement New feature or request v2.0.0 labels Jan 8, 2024
@sserrata sserrata added this to the v2.0 UI/UX Refresh milestone Jan 8, 2024
@sserrata sserrata self-assigned this Jan 8, 2024
Copy link

github-actions bot commented Jan 8, 2024

Size Change: +1.21 kB (0%)

Total Size: 6.03 MB

Filename Size Change
demo/build/assets/js/4c5e977b.********.js 71 kB +93 B (0%)
demo/build/assets/js/common.********.js 416 kB +466 B (0%)
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 18.9 kB 0 B
demo/build/assets/css/styles.********.css 124 kB 0 B
demo/build/assets/js/006e727e.********.js 11.3 kB +9 B (0%)
demo/build/assets/js/05f64ae1.********.js 2.88 kB 0 B
demo/build/assets/js/06b64fc1.********.js 575 B 0 B
demo/build/assets/js/06e5f0f0.********.js 14.8 kB +9 B (0%)
demo/build/assets/js/081bfb0d.********.js 6.91 kB +9 B (0%)
demo/build/assets/js/09e07b87.********.js 3.03 kB 0 B
demo/build/assets/js/0d832478.********.js 18.5 kB +9 B (0%)
demo/build/assets/js/12693653.********.js 18.2 kB +9 B (0%)
demo/build/assets/js/14eb3368.********.js 8.75 kB 0 B
demo/build/assets/js/1639936b.********.js 8.96 kB 0 B
demo/build/assets/js/16577668.********.js 387 B 0 B
demo/build/assets/js/177e86db.********.js 7.95 kB +9 B (0%)
demo/build/assets/js/19d75775.********.js 6.32 kB +9 B (0%)
demo/build/assets/js/1a4e3797.********.js 78.7 kB 0 B
demo/build/assets/js/1a8cc2a6.********.js 9.43 kB +9 B (0%)
demo/build/assets/js/1be78505.********.js 12 kB 0 B
demo/build/assets/js/1c54f54e.********.js 7.5 kB +9 B (0%)
demo/build/assets/js/1e6c5cae.********.js 24.9 kB +9 B (0%)
demo/build/assets/js/1e6ff21d.********.js 8 kB +9 B (0%)
demo/build/assets/js/1f818248.********.js 8.57 kB +9 B (0%)
demo/build/assets/js/2086.********.js 3.36 MB 0 B
demo/build/assets/js/2bb7a9e5.********.js 14.4 kB +9 B (0%)
demo/build/assets/js/2c860537.********.js 5.86 kB +9 B (0%)
demo/build/assets/js/3136173c.********.js 361 B 0 B
demo/build/assets/js/326c3861.********.js 14.8 kB 0 B
demo/build/assets/js/3720c009.********.js 1.94 kB 0 B
demo/build/assets/js/3893.********.js 1.07 kB 0 B
demo/build/assets/js/3946f914.********.js 24.1 kB +9 B (0%)
demo/build/assets/js/39d00f16.********.js 17 kB 0 B
demo/build/assets/js/3e0d14e9.********.js 17.5 kB +9 B (0%)
demo/build/assets/js/40a238b6.********.js 18.2 kB +9 B (0%)
demo/build/assets/js/41cd56a1.********.js 7.58 kB +9 B (0%)
demo/build/assets/js/423cd203.********.js 10.8 kB +9 B (0%)
demo/build/assets/js/466ac800.********.js 28.8 kB +9 B (0%)
demo/build/assets/js/4670.********.js 104 B 0 B
demo/build/assets/js/46afcded.********.js 8.21 kB 0 B
demo/build/assets/js/46e5c6ac.********.js 6.86 kB 0 B
demo/build/assets/js/47abaca6.********.js 2.95 kB 0 B
demo/build/assets/js/4964e910.********.js 17 kB +9 B (0%)
demo/build/assets/js/49bd3d39.********.js 12.8 kB +9 B (0%)
demo/build/assets/js/4b891ed6.********.js 8.48 kB +9 B (0%)
demo/build/assets/js/4b901b1a.********.js 350 B 0 B
demo/build/assets/js/55960ee5.********.js 383 B 0 B
demo/build/assets/js/55a6d13f.********.js 11.2 kB +9 B (0%)
demo/build/assets/js/56717cba.********.js 3.03 kB 0 B
demo/build/assets/js/57f1a671.********.js 8.53 kB +9 B (0%)
demo/build/assets/js/58ff8b1e.********.js 22.2 kB +11 B (0%)
demo/build/assets/js/597ddc40.********.js 7.46 kB +9 B (0%)
demo/build/assets/js/5fb917be.********.js 2.71 kB +9 B (0%)
demo/build/assets/js/63fc267d.********.js 8.04 kB +9 B (0%)
demo/build/assets/js/66c76a57.********.js 24.8 kB +9 B (0%)
demo/build/assets/js/68b61ac5.********.js 29.5 kB +9 B (0%)
demo/build/assets/js/69a61f78.********.js 17.6 kB +9 B (0%)
demo/build/assets/js/6a105426.********.js 354 B 0 B
demo/build/assets/js/73b594ee.********.js 24.9 kB +9 B (0%)
demo/build/assets/js/77264a1a.********.js 24.2 kB +9 B (0%)
demo/build/assets/js/785615ec.********.js 14.3 kB +9 B (0%)
demo/build/assets/js/7ca3ae45.********.js 13.3 kB +9 B (0%)
demo/build/assets/js/7ed7dafe.********.js 18.5 kB +9 B (0%)
demo/build/assets/js/85d3c400.********.js 2.96 kB 0 B
demo/build/assets/js/85ec4403.********.js 4.31 kB +9 B (0%)
demo/build/assets/js/86b273b1.********.js 7.95 kB +9 B (0%)
demo/build/assets/js/86c346b0.********.js 538 B 0 B
demo/build/assets/js/86c45737.********.js 18.7 kB +9 B (0%)
demo/build/assets/js/8777.********.js 76.5 kB 0 B
demo/build/assets/js/881db345.********.js 394 B 0 B
demo/build/assets/js/8961c7a6.********.js 18.4 kB +9 B (0%)
demo/build/assets/js/8ab9b16e.********.js 7.37 kB +9 B (0%)
demo/build/assets/js/8d4e78cd.********.js 2.9 kB 0 B
demo/build/assets/js/8f36b2a3.********.js 172 B 0 B
demo/build/assets/js/8f441c78.********.js 16.9 kB 0 B
demo/build/assets/js/9127.********.js 104 B 0 B
demo/build/assets/js/91696e06.********.js 24.9 kB +9 B (0%)
demo/build/assets/js/93304a97.********.js 9.08 kB 0 B
demo/build/assets/js/935f2afb.********.js 34 kB 0 B
demo/build/assets/js/94589c06.********.js 15.1 kB +9 B (0%)
demo/build/assets/js/967247e2.********.js 12.3 kB 0 B
demo/build/assets/js/97810f3c.********.js 17.6 kB +9 B (0%)
demo/build/assets/js/9b5caaf3.********.js 18.2 kB +9 B (0%)
demo/build/assets/js/9c42c0f3.********.js 23.9 kB +9 B (0%)
demo/build/assets/js/a40c6d71.********.js 5.78 kB +9 B (0%)
demo/build/assets/js/a476e24e.********.js 344 B 0 B
demo/build/assets/js/a6cd895f.********.js 22.7 kB +11 B (0%)
demo/build/assets/js/a728d93a.********.js 7.41 kB +9 B (0%)
demo/build/assets/js/aa2f1ec7.********.js 17.8 kB +9 B (0%)
demo/build/assets/js/ab09fd5c.********.js 22.7 kB +11 B (0%)
demo/build/assets/js/ab6072f2.********.js 17.6 kB +9 B (0%)
demo/build/assets/js/ae7f40a3.********.js 29.5 kB +9 B (0%)
demo/build/assets/js/b4ebd305.********.js 13.2 kB +9 B (0%)
demo/build/assets/js/b5c059ef.********.js 24 kB +9 B (0%)
demo/build/assets/js/b89b49f4.********.js 9.79 kB 0 B
demo/build/assets/js/bead4b8e.********.js 3.08 kB 0 B
demo/build/assets/js/c5644638.********.js 337 B 0 B
demo/build/assets/js/c65697f5.********.js 17.9 kB +9 B (0%)
demo/build/assets/js/c7a5be9f.********.js 7.54 kB +9 B (0%)
demo/build/assets/js/c7ded1cb.********.js 3.01 kB 0 B
demo/build/assets/js/cef3f2e2.********.js 5.71 kB 0 B
demo/build/assets/js/cf07762b.********.js 18.7 kB +9 B (0%)
demo/build/assets/js/d63c7029.********.js 2.98 kB 0 B
demo/build/assets/js/dd696920.********.js 17.6 kB +9 B (0%)
demo/build/assets/js/df203c0f.********.js 2.9 kB 0 B
demo/build/assets/js/e015ccf9.********.js 18.2 kB +9 B (0%)
demo/build/assets/js/e01f8d18.********.js 6.29 kB +9 B (0%)
demo/build/assets/js/e2ce9793.********.js 397 B 0 B
demo/build/assets/js/e5e5340c.********.js 2.62 kB +9 B (0%)
demo/build/assets/js/e8b309fb.********.js 577 B 0 B
demo/build/assets/js/eae14b71.********.js 23.2 kB +9 B (0%)
demo/build/assets/js/eaf4471e.********.js 9.38 kB +9 B (0%)
demo/build/assets/js/ecc39b49.********.js 172 B 0 B
demo/build/assets/js/ee308fa3.********.js 7.09 kB +9 B (0%)
demo/build/assets/js/f212caf7.********.js 18.3 kB +9 B (0%)
demo/build/assets/js/f4486b6b.********.js 8.93 kB +9 B (0%)
demo/build/assets/js/f65290a6.********.js 7.9 kB +9 B (0%)
demo/build/assets/js/f8409a7e.********.js 40.5 kB 0 B
demo/build/assets/js/f84e10c2.********.js 14.3 kB +9 B (0%)
demo/build/assets/js/fcd67c8d.********.js 13.7 kB +9 B (0%)
demo/build/assets/js/fe97f0d1.********.js 15.1 kB +9 B (0%)
demo/build/assets/js/main.********.js 486 kB 0 B
demo/build/assets/js/runtime~main.********.js 9.01 kB 0 B
demo/build/index.html 95.8 kB 0 B

compressed-size-action

Copy link

github-actions bot commented Jan 8, 2024

Visit the preview URL for this PR (updated for commit 7b2ba6c):

https://docusaurus-openapi-36b86--pr690-nsf4m7xs.web.app

(expires Thu, 08 Feb 2024 16:20:45 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata requested a review from blindaa121 January 8, 2024 13:35
@sserrata
Copy link
Member Author

sserrata commented Jan 8, 2024

@blindaa121 thoughts on using the name "Markdown" for the component? My concern is that it could conflict with other themes. I was also thinking something like CommonMarkdown or BaseMarkdown.

@sserrata sserrata merged commit 91dec39 into main Jan 9, 2024
13 checks passed
@sserrata sserrata deleted the examples/summary-markdown branch January 9, 2024 16:21
sserrata added a commit that referenced this pull request Jan 18, 2024
* Add Markdown import to api doc generator

* support markdown rendering for example summary

* add markdown component

* install missing eslint package

* fix import order

* update lock file
sserrata added a commit that referenced this pull request Jan 18, 2024
* Prepare release v3.0.0-beta.5

* Add markdown support to example summary (#690)

* Add Markdown import to api doc generator

* support markdown rendering for example summary

* add markdown component

* install missing eslint package

* fix import order

* update lock file

* Remove deprecated node packages (#699)

* Remove deprecated node packages

* Update languages.json

* Update languagetabs.md

* Prepare release v3.0.0-beta.5

---------

Co-authored-by: Doron Bargo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v2.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant