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

[Enhancement] Use docs with embedded links as category link #114

Merged
merged 13 commits into from
Jun 1, 2022

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Jun 1, 2022

Description

See #112 for problem this PR addresses.

  • Adds new *.tag.mdx doc type

Motivation and Context

Enables markdown/MDX support for tag descriptions when setting categoryLinkSource to "tag".

How Has This Been Tested?

This has not been fully tested but will update once a suitable spec file is found.

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@sserrata sserrata added the enhancement New feature or request label Jun 1, 2022
@sserrata
Copy link
Member Author

sserrata commented Jun 1, 2022

Tested by modifying the existing Petstore OAS:

Screen.Recording.2022-06-01.at.9.37.25.AM.mov

@github-actions
Copy link

github-actions bot commented Jun 1, 2022

Size Change: +14.5 kB (+1%)

Total Size: 2.73 MB

Filename Size Change
demo/build/assets/js/14eb3368.********.js 8.88 kB +91 B (+1%)
demo/build/assets/js/7ac26ed1.********.js 0 B -438 B (removed) 🏆
demo/build/assets/js/8e4a0e36.********.js 0 B -445 B (removed) 🏆
demo/build/assets/js/935f2afb.********.js 21.8 kB +582 B (+3%)
demo/build/assets/js/cdd5af7d.********.js 0 B -494 B (removed) 🏆
demo/build/assets/js/main.********.js 413 kB -161 B (0%)
demo/build/assets/js/05f64ae1.********.js 5.1 kB +5.1 kB (new file) 🆕
demo/build/assets/js/47abaca6.********.js 5.2 kB +5.2 kB (new file) 🆕
demo/build/assets/js/8d4e78cd.********.js 5.11 kB +5.11 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 10.1 kB -27 B (0%)
demo/build/assets/css/styles.********.css 84.3 kB 0 B
demo/build/assets/js/01a85c17.********.js 2.72 kB 0 B
demo/build/assets/js/031793e1.********.js 214 B 0 B
demo/build/assets/js/06e5f0f0.********.js 36.5 kB 0 B
demo/build/assets/js/096bfee4.********.js 260 B 0 B
demo/build/assets/js/0b8a056b.********.js 9.18 kB 0 B
demo/build/assets/js/0ccfb8d7.********.js 449 B 0 B
demo/build/assets/js/0e384e19.********.js 5.91 kB 0 B
demo/build/assets/js/1639936b.********.js 3.69 kB 0 B
demo/build/assets/js/18c41134.********.js 16.9 kB 0 B
demo/build/assets/js/1be78505.********.js 10.9 kB 0 B
demo/build/assets/js/1e4232ab.********.js 5.62 kB 0 B
demo/build/assets/js/1f391b9e.********.js 2.6 kB 0 B
demo/build/assets/js/1f818248.********.js 18.9 kB 0 B
demo/build/assets/js/2610c6ee.********.js 25 kB 0 B
demo/build/assets/js/2a3d8b7d.********.js 18.6 kB 0 B
demo/build/assets/js/2b60538e.********.js 22.9 kB 0 B
demo/build/assets/js/2c860537.********.js 13.9 kB 0 B
demo/build/assets/js/2ee3fbbb.********.js 18.1 kB 0 B
demo/build/assets/js/30a24c52.********.js 207 B 0 B
demo/build/assets/js/36675a4b.********.js 29.3 kB 0 B
demo/build/assets/js/393be207.********.js 3.08 kB 0 B
demo/build/assets/js/39d00f16.********.js 7.95 kB -3 B (0%)
demo/build/assets/js/4360.********.js 118 kB 0 B
demo/build/assets/js/4920.********.js 13.4 kB 0 B
demo/build/assets/js/4bdd3fbe.********.js 22.3 kB 0 B
demo/build/assets/js/4c5e977b.********.js 31.3 kB 0 B
demo/build/assets/js/4c9e35b1.********.js 256 B 0 B
demo/build/assets/js/533a09ca.********.js 4.96 kB 0 B
demo/build/assets/js/534cc848.********.js 431 B 0 B
demo/build/assets/js/5570.********.js 1.1 MB 0 B
demo/build/assets/js/59362658.********.js 5.14 kB 0 B
demo/build/assets/js/5c868d36.********.js 5.7 kB 0 B
demo/build/assets/js/5fb917be.********.js 9.58 kB 0 B
demo/build/assets/js/608ae6a4.********.js 262 B 0 B
demo/build/assets/js/6119.********.js 1.09 kB 0 B
demo/build/assets/js/66406991.********.js 256 B 0 B
demo/build/assets/js/6875c492.********.js 9.6 kB 0 B
demo/build/assets/js/6b63c616.********.js 27.7 kB -10 B (0%)
demo/build/assets/js/73664a40.********.js 7.18 kB 0 B
demo/build/assets/js/7633a546.********.js 17 kB 0 B
demo/build/assets/js/7661071f.********.js 5.23 kB 0 B
demo/build/assets/js/7a6145e6.********.js 416 B 0 B
demo/build/assets/js/7a7d82e8.********.js 24.2 kB 0 B
demo/build/assets/js/814f3328.********.js 392 B 0 B
demo/build/assets/js/822bd8ab.********.js 5.34 kB 0 B
demo/build/assets/js/838d665e.********.js 191 B 0 B
demo/build/assets/js/85ec4403.********.js 11.4 kB 0 B
demo/build/assets/js/8717b14a.********.js 3.98 kB 0 B
demo/build/assets/js/8ab9b16e.********.js 16.6 kB 0 B
demo/build/assets/js/925b3f96.********.js 4.22 kB 0 B
demo/build/assets/js/93304a97.********.js 3.82 kB 0 B
demo/build/assets/js/9c58e5d3.********.js 23.5 kB -1 B (0%)
demo/build/assets/js/9e4087bc.********.js 1.7 kB 0 B
demo/build/assets/js/a6aa9e1f.********.js 9.02 kB 0 B
demo/build/assets/js/a6cd895f.********.js 27.5 kB -1 B (0%)
demo/build/assets/js/a7023ddc.********.js 518 B 0 B
demo/build/assets/js/a80da1cf.********.js 218 B 0 B
demo/build/assets/js/b2b675dd.********.js 245 B 0 B
demo/build/assets/js/b2f554cd.********.js 8.79 kB 0 B
demo/build/assets/js/b802b434.********.js 411 B 0 B
demo/build/assets/js/b8b62e90.********.js 26.6 kB 0 B
demo/build/assets/js/bf9a5101.********.js 24.7 kB 0 B
demo/build/assets/js/c2838c41.********.js 24.2 kB 0 B
demo/build/assets/js/c4f5d8e4.********.js 72.7 kB 0 B
demo/build/assets/js/c800bce3.********.js 556 B 0 B
demo/build/assets/js/c844b82d.********.js 441 B 0 B
demo/build/assets/js/ccc49370.********.js 11.1 kB 0 B
demo/build/assets/js/cfd5b083.********.js 415 B 0 B
demo/build/assets/js/d69e68dd.********.js 17.4 kB 0 B
demo/build/assets/js/d90c1c35.********.js 18 kB 0 B
demo/build/assets/js/d9f32620.********.js 5.23 kB 0 B
demo/build/assets/js/dd696920.********.js 23.6 kB -1 B (0%)
demo/build/assets/js/dff1c289.********.js 6.34 kB 0 B
demo/build/assets/js/e16015ca.********.js 205 B 0 B
demo/build/assets/js/e273c56f.********.js 4.22 kB 0 B
demo/build/assets/js/e44a2883.********.js 7.67 kB 0 B
demo/build/assets/js/e5cbb61f.********.js 192 B 0 B
demo/build/assets/js/e5e5340c.********.js 9.48 kB 0 B
demo/build/assets/js/e6f78ab2.********.js 15.8 kB 0 B
demo/build/assets/js/ea88f2a1.********.js 474 B 0 B
demo/build/assets/js/ecc39b49.********.js 191 B 0 B
demo/build/assets/js/eff95040.********.js 27.1 kB 0 B
demo/build/assets/js/f4f34a3a.********.js 5.14 kB 0 B
demo/build/assets/js/f55d3e7a.********.js 5.17 kB 0 B
demo/build/assets/js/fdd24af5.********.js 16.9 kB -10 B (0%)
demo/build/assets/js/runtime~main.********.js 7.95 kB -1 B (0%)
demo/build/index.html 74.8 kB 0 B

compressed-size-action

@github-actions
Copy link

github-actions bot commented Jun 1, 2022

Visit the preview URL for this PR (updated for commit 69e3ddb):

https://docusaurus-openapi-36b86--pr114-0o2jxn5l.web.app

(expires Fri, 01 Jul 2022 15:01:15 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata requested a review from blindaa121 June 1, 2022 17:44
@sserrata
Copy link
Member Author

sserrata commented Jun 1, 2022

Also confirmed that no "tag docs" are generated if categoryLinkSource is undefined or set to "info".

@sserrata sserrata merged commit f51c38f into main Jun 1, 2022
@sserrata sserrata deleted the tag-doc-pages branch June 1, 2022 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant