Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Add admonition support to descriptions/summaries #1016

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

Merged
sserrata merged 23 commits into main from remark-admonitions
Nov 22, 2024
Merged

Conversation

@sserrata
Copy link
Member

@sserrata sserrata commented Nov 7, 2024 •
edited
Loading

Description

See #1012 for background

In addition to adding support for admonitions this PR also seeks to extend that markdown support to:

  • Schema property descriptions
  • Example summaries/descriptions
  • Descriptions and summaries everywhere else

tuanpt-0634 reacted with hooray emoji
@sserrata sserrata added the v4.0.0 v4.0.0 label Nov 7, 2024
@sserrata sserrata self-assigned this Nov 7, 2024
@sserrata sserrata changed the title (削除) Draft: Add experimental admonition support (削除ここまで) (追記) Draft: Add experimental admonition support to descriptions/summaries (追記ここまで) Nov 7, 2024
Copy link

github-actions bot commented Nov 7, 2024 •
edited
Loading

Size Change: +3.94 kB (+0.2%)

Total Size: 2.02 MB

Filename Size Change
demo/build/petstore/add-pet/index.html 27.4 kB +5.29 kB (+24%) 🚨
demo/build/petstore/schemas/cat/index.html 36.7 kB -198 B (-0.54%)
demo/build/petstore/schemas/category/index.html 23.9 kB -44 B (-0.18%)
demo/build/petstore/schemas/dog/index.html 37.1 kB -198 B (-0.53%)
demo/build/petstore/schemas/honeybee/index.html 37.2 kB -198 B (-0.53%)
demo/build/petstore/schemas/order/index.html 25 kB -77 B (-0.31%)
demo/build/petstore/schemas/pet/index.html 36.6 kB -198 B (-0.54%)
demo/build/petstore/schemas/tag/index.html 22.3 kB -33 B (-0.15%)
demo/build/petstore/schemas/user/index.html 44.8 kB -363 B (-0.8%)
i️ View Unchanged
Filename Size Change
demo/.docusaurus/codeTranslations.json 2 B 0 B
demo/.docusaurus/docusaurus.config.mjs 13.9 kB 0 B
demo/.docusaurus/globalData.json 38.6 kB 0 B
demo/.docusaurus/i18n.json 267 B 0 B
demo/.docusaurus/registry.js 56.9 kB 0 B
demo/.docusaurus/routes.js 52.6 kB 0 B
demo/.docusaurus/routesChunkNames.json 21.8 kB 0 B
demo/.docusaurus/site-metadata.json 1.23 kB 0 B
demo/build/assets/css/styles.********.css 145 kB 0 B
demo/build/assets/js/main.********.js 691 kB 0 B
demo/build/assets/js/runtime~main.********.js 15.1 kB 0 B
demo/build/index.html 90.4 kB 0 B
demo/build/petstore/create-user/index.html 21.5 kB -1 B (0%)
demo/build/petstore/create-users-with-array-input/index.html 21.5 kB -1 B (0%)
demo/build/petstore/create-users-with-list-input/index.html 21.5 kB -1 B (0%)
demo/build/petstore/delete-order/index.html 21.5 kB -2 B (-0.01%)
demo/build/petstore/delete-pet/index.html 21.6 kB -1 B (0%)
demo/build/petstore/delete-user/index.html 21.8 kB -2 B (-0.01%)
demo/build/petstore/find-pets-by-status/index.html 22.2 kB -2 B (-0.01%)
demo/build/petstore/find-pets-by-tags/index.html 22.9 kB -2 B (-0.01%)
demo/build/petstore/get-inventory/index.html 20.8 kB -1 B (0%)
demo/build/petstore/get-order-by-id/index.html 21.7 kB -3 B (-0.01%)
demo/build/petstore/get-pet-by-id/index.html 22.3 kB -3 B (-0.01%)
demo/build/petstore/get-user-by-name/index.html 21.9 kB -3 B (-0.01%)
demo/build/petstore/login-user/index.html 22.4 kB -5 B (-0.02%)
demo/build/petstore/logout-user/index.html 21.2 kB -1 B (0%)
demo/build/petstore/new-pet/index.html 21.8 kB -1 B (0%)
demo/build/petstore/pet/index.html 23.5 kB 0 B
demo/build/petstore/place-order/index.html 21 kB -2 B (-0.01%)
demo/build/petstore/schemas/apiresponse/index.html 22.8 kB 0 B
demo/build/petstore/schemas/id/index.html 20.9 kB 0 B
demo/build/petstore/store/index.html 21.4 kB 0 B
demo/build/petstore/subscribe-to-the-store-events/index.html 27.8 kB -7 B (-0.03%)
demo/build/petstore/swagger-petstore-yaml/index.html 27.9 kB 0 B
demo/build/petstore/update-pet-with-form/index.html 21.7 kB -1 B (0%)
demo/build/petstore/update-pet/index.html 22.2 kB -3 B (-0.01%)
demo/build/petstore/update-user/index.html 21.8 kB -2 B (-0.01%)
demo/build/petstore/upload-file/index.html 21.6 kB -1 B (0%)
demo/build/petstore/user/index.html 22.4 kB 0 B

compressed-size-action

Copy link

github-actions bot commented Nov 7, 2024 •
edited
Loading

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

https://docusaurus-openapi-36b86--pr1016-wu0mmkeo.web.app

(expires 2024年12月21日 18:44:38 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bf293780ee827f578864d92193b8c2866acd459f

@sserrata sserrata marked this pull request as draft November 7, 2024 03:51
@sserrata sserrata marked this pull request as ready for review November 18, 2024 23:35
@sserrata sserrata changed the title (削除) Draft: Add experimental admonition support to descriptions/summaries (削除ここまで) (追記) Add admonition support to descriptions/summaries (追記ここまで) Nov 18, 2024
@sserrata sserrata merged commit b143240 into main Nov 22, 2024
9 checks passed
@sserrata sserrata deleted the remark-admonitions branch November 22, 2024 00:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@blindaa121 blindaa121 Awaiting requested review from blindaa121

Labels

v4.0.0 v4.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

AltStyle によって変換されたページ (->オリジナル) /