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

[Bug] Fix support for markdown template #239

Merged
merged 6 commits into from
Sep 6, 2022
Merged

[Bug] Fix support for markdown template #239

merged 6 commits into from
Sep 6, 2022

Conversation

sserrata
Copy link
Member

@sserrata sserrata commented Sep 6, 2022

Description

Introduces changes/fixes to allow users to specify a mustache template file for customizing the markdown/MDX structure for API docs. Although it's technically possible to prepend or append content to the ApiItem and ApiDemoPanel sections the primary use case is to customize the MDX frontmatter.

Motivation and Context

Allows users to customize how the API MDX is rendered so they can do things like customize the frontmatter custom_edit_url and other fields.

How Has This Been Tested?

Tested with Petstore API. This PR also includes a sample mustache template and usage.

@sserrata sserrata added bug Something isn't working enhancement New feature or request labels Sep 6, 2022
@github-actions
Copy link

github-actions bot commented Sep 6, 2022

Size Change: +12.9 kB (0%)

Total Size: 3.68 MB

Filename Size Change
demo/build/assets/js/05f64ae1.********.js 2.74 kB -46 B (-2%)
demo/build/assets/js/09e07b87.********.js 2.92 kB -58 B (-2%)
demo/build/assets/js/177e86db.********.js 10.8 kB +581 B (+6%) 🔍
demo/build/assets/js/19d75775.********.js 9.08 kB +615 B (+7%) 🔍
demo/build/assets/js/39d00f16.********.js 10.4 kB +580 B (+6%) 🔍
demo/build/assets/js/47abaca6.********.js 2.83 kB -48 B (-2%)
demo/build/assets/js/4b891ed6.********.js 11.7 kB +639 B (+6%) 🔍
demo/build/assets/js/55a6d13f.********.js 14.2 kB +571 B (+4%)
demo/build/assets/js/56717cba.********.js 2.89 kB -63 B (-2%)
demo/build/assets/js/66c76a57.********.js 34.9 kB +574 B (+2%)
demo/build/assets/js/68b61ac5.********.js 44.4 kB +571 B (+1%)
demo/build/assets/js/73b594ee.********.js 34.8 kB +564 B (+2%)
demo/build/assets/js/7ed7dafe.********.js 26.6 kB +534 B (+2%)
demo/build/assets/js/85d3c400.********.js 2.82 kB -56 B (-2%)
demo/build/assets/js/86c45737.********.js 23.8 kB +568 B (+2%)
demo/build/assets/js/8ab9b16e.********.js 10.1 kB +531 B (+6%) 🔍
demo/build/assets/js/8d4e78cd.********.js 2.76 kB -47 B (-2%)
demo/build/assets/js/94589c06.********.js 19.5 kB +570 B (+3%)
demo/build/assets/js/9b5caaf3.********.js 26 kB +666 B (+3%)
demo/build/assets/js/9c42c0f3.********.js 34.3 kB +544 B (+2%)
demo/build/assets/js/a6cd895f.********.js 21.7 kB +621 B (+3%)
demo/build/assets/js/b4ebd305.********.js 17.5 kB +581 B (+3%)
demo/build/assets/js/bead4b8e.********.js 2.96 kB -64 B (-2%)
demo/build/assets/js/c7a5be9f.********.js 10.5 kB +535 B (+5%) 🔍
demo/build/assets/js/c7ded1cb.********.js 2.87 kB -62 B (-2%)
demo/build/assets/js/d63c7029.********.js 2.85 kB -57 B (-2%)
demo/build/assets/js/dd696920.********.js 25.4 kB +531 B (+2%)
demo/build/assets/js/e015ccf9.********.js 26 kB +661 B (+3%)
demo/build/assets/js/eaf4471e.********.js 12.3 kB +546 B (+5%) 🔍
demo/build/assets/js/f212caf7.********.js 23.2 kB +562 B (+2%)
demo/build/assets/js/f65290a6.********.js 10.7 kB +601 B (+6%) 🔍
demo/build/assets/js/main.********.js 392 kB +34 B (0%)
ℹ️ View Unchanged
Filename Size Change
demo/.docusaurus/globalData.json 19.1 kB 0 B
demo/build/assets/css/styles.********.css 92.8 kB 0 B
demo/build/assets/js/006e727e.********.js 13.8 kB +10 B (0%)
demo/build/assets/js/06b64fc1.********.js 575 B 0 B
demo/build/assets/js/06e5f0f0.********.js 27.1 kB +10 B (0%)
demo/build/assets/js/081bfb0d.********.js 9.81 kB +10 B (0%)
demo/build/assets/js/0d832478.********.js 26.2 kB +10 B (0%)
demo/build/assets/js/12693653.********.js 25.5 kB +10 B (0%)
demo/build/assets/js/14eb3368.********.js 9.19 kB 0 B
demo/build/assets/js/1639936b.********.js 4.34 kB +10 B (0%)
demo/build/assets/js/16577668.********.js 387 B 0 B
demo/build/assets/js/18c41134.********.js 12.7 kB +10 B (0%)
demo/build/assets/js/1a8cc2a6.********.js 11.9 kB +10 B (0%)
demo/build/assets/js/1be78505.********.js 10.3 kB 0 B
demo/build/assets/js/1c54f54e.********.js 10.4 kB +10 B (0%)
demo/build/assets/js/1e4232ab.********.js 3.16 kB +10 B (0%)
demo/build/assets/js/1e6c5cae.********.js 34.4 kB +10 B (0%)
demo/build/assets/js/1e6ff21d.********.js 10.3 kB +10 B (0%)
demo/build/assets/js/1f818248.********.js 11.1 kB +10 B (0%)
demo/build/assets/js/2c860537.********.js 6.96 kB +10 B (0%)
demo/build/assets/js/326c3861.********.js 10 kB +10 B (0%)
demo/build/assets/js/3893.********.js 1.07 kB 0 B
demo/build/assets/js/3946f914.********.js 34.4 kB +10 B (0%)
demo/build/assets/js/3e0d14e9.********.js 22.8 kB +10 B (0%)
demo/build/assets/js/40a238b6.********.js 25.5 kB +10 B (0%)
demo/build/assets/js/41cd56a1.********.js 10.1 kB +10 B (0%)
demo/build/assets/js/423cd203.********.js 13.8 kB +10 B (0%)
demo/build/assets/js/4261.********.js 480 B 0 B
demo/build/assets/js/466ac800.********.js 43.8 kB +10 B (0%)
demo/build/assets/js/46afcded.********.js 8.14 kB +10 B (0%)
demo/build/assets/js/46e5c6ac.********.js 6.67 kB +10 B (0%)
demo/build/assets/js/4935.********.js 1.05 kB 0 B
demo/build/assets/js/4964e910.********.js 25 kB +10 B (0%)
demo/build/assets/js/49bd3d39.********.js 17.1 kB +10 B (0%)
demo/build/assets/js/4c5e977b.********.js 31.6 kB 0 B
demo/build/assets/js/533a09ca.********.js 2.49 kB +10 B (0%)
demo/build/assets/js/57f1a671.********.js 11.2 kB +10 B (0%)
demo/build/assets/js/58ff8b1e.********.js 21.3 kB +10 B (0%)
demo/build/assets/js/597ddc40.********.js 10.3 kB +10 B (0%)
demo/build/assets/js/5c868d36.********.js 3.25 kB +10 B (0%)
demo/build/assets/js/5fb917be.********.js 2.53 kB +10 B (0%)
demo/build/assets/js/63fc267d.********.js 11.3 kB +10 B (0%)
demo/build/assets/js/6568.********.js 1.31 MB 0 B
demo/build/assets/js/69a61f78.********.js 25.4 kB +10 B (0%)
demo/build/assets/js/77264a1a.********.js 34.2 kB +10 B (0%)
demo/build/assets/js/7ca3ae45.********.js 17.1 kB +10 B (0%)
demo/build/assets/js/8003.********.js 5.45 kB 0 B
demo/build/assets/js/822bd8ab.********.js 2.88 kB +10 B (0%)
demo/build/assets/js/85ec4403.********.js 4.47 kB +10 B (0%)
demo/build/assets/js/86b273b1.********.js 10.3 kB +10 B (0%)
demo/build/assets/js/86c346b0.********.js 538 B 0 B
demo/build/assets/js/881db345.********.js 394 B 0 B
demo/build/assets/js/8961c7a6.********.js 22.8 kB +10 B (0%)
demo/build/assets/js/8f441c78.********.js 9.98 kB +10 B (0%)
demo/build/assets/js/91696e06.********.js 34.5 kB +10 B (0%)
demo/build/assets/js/93304a97.********.js 4.46 kB +10 B (0%)
demo/build/assets/js/935f2afb.********.js 32.2 kB 0 B
demo/build/assets/js/97810f3c.********.js 25 kB +10 B (0%)
demo/build/assets/js/a40c6d71.********.js 8.57 kB +10 B (0%)
demo/build/assets/js/a5491aaa.********.js 400 B 0 B
demo/build/assets/js/a728d93a.********.js 9.74 kB +10 B (0%)
demo/build/assets/js/aa2f1ec7.********.js 23.3 kB +10 B (0%)
demo/build/assets/js/ab09fd5c.********.js 21.2 kB +10 B (0%)
demo/build/assets/js/ab6072f2.********.js 25.4 kB +10 B (0%)
demo/build/assets/js/ae7f40a3.********.js 44 kB +10 B (0%)
demo/build/assets/js/b5c059ef.********.js 33.9 kB +10 B (0%)
demo/build/assets/js/bf271e74.********.js 401 B 0 B
demo/build/assets/js/c65697f5.********.js 26.1 kB +10 B (0%)
demo/build/assets/js/cf07762b.********.js 23.3 kB +10 B (0%)
demo/build/assets/js/common.********.js 159 kB 0 B
demo/build/assets/js/dff1c289.********.js 3.9 kB +10 B (0%)
demo/build/assets/js/e01f8d18.********.js 8.51 kB +10 B (0%)
demo/build/assets/js/e2ce9793.********.js 402 B 0 B
demo/build/assets/js/e44a2883.********.js 4.54 kB +10 B (0%)
demo/build/assets/js/e5e5340c.********.js 2.46 kB +10 B (0%)
demo/build/assets/js/e8b309fb.********.js 577 B 0 B
demo/build/assets/js/eae14b71.********.js 33.8 kB +10 B (0%)
demo/build/assets/js/ecc39b49.********.js 172 B 0 B
demo/build/assets/js/ee308fa3.********.js 10.1 kB +10 B (0%)
demo/build/assets/js/f4486b6b.********.js 12 kB +10 B (0%)
demo/build/assets/js/f55d3e7a.********.js 2.71 kB +10 B (0%)
demo/build/assets/js/f8409a7e.********.js 29.1 kB +10 B (0%)
demo/build/assets/js/f84e10c2.********.js 19.1 kB +10 B (0%)
demo/build/assets/js/fe97f0d1.********.js 19 kB +10 B (0%)
demo/build/assets/js/runtime~main.********.js 8.71 kB 0 B
demo/build/index.html 80.1 kB +10 B (0%)

compressed-size-action

@github-actions
Copy link

github-actions bot commented Sep 6, 2022

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

https://docusaurus-openapi-36b86--pr239-yxl9r0k2.web.app

(expires Thu, 06 Oct 2022 13:19:06 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

@sserrata sserrata merged commit b3330a6 into main Sep 6, 2022
@sserrata sserrata deleted the md-templates branch September 6, 2022 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant