Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

feat(codeblock): added multi-language code block functionality for API docs - #3261

Merged
ovflowd merged 4 commits into
mainfrom
feat/merged-code-blocks
Mar 11, 2023
Merged

ovflowd merged 4 commits into
mainfrom
feat/merged-code-blocks

Conversation

@ovflowd

@ovflowd ovflowd commented Mar 8, 2023

Copy link
Copy Markdown
Member

Description

This PR introduces the support and grouping of API Docs Code Blocks into a single Code Block. This uses then our Codebox component (#3249) to support switching between languages.

The PR also attempts to solve a pertinent issue regarding the docs generation process (which is an unrelated change, but small enough to be part of this PR. It can be decoupled from this PR if the reviewers deem it needed).

Related Issues

Closes #2844

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Patch coverage has no change and project coverage change: -1.29 ⚠️

Comparison is base (fd57b87) 66.02% compared to head (49f656f) 64.73%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3261      +/-   ##
==========================================
- Coverage   66.02%   64.73%   -1.29%     
==========================================
  Files         118      145      +27     
  Lines        1351     1764     +413     
  Branches      342      411      +69     
==========================================
+ Hits          892     1142     +250     
- Misses        422      573     +151     
- Partials       37       49      +12     

see 197 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@ovflowd

ovflowd commented Mar 10, 2023

Copy link
Copy Markdown
Member Author

@shanpriyan could I get a review? :)

@shanpriyan shanpriyan added the create-preview Generate preview on staging.nodejs.dev label Mar 10, 2023
@github-actions github-actions Bot removed the create-preview Generate preview on staging.nodejs.dev label Mar 10, 2023
@github-actions

Copy link
Copy Markdown

Please find a preview at: https://staging.nodejs.dev/3261/

@ovflowd

ovflowd commented Mar 10, 2023

Copy link
Copy Markdown
Member Author

@shanpriyan this PR is not something you can see in a preview. You will need to checkout locally and run the sync-api command.

Comment thread util-node/getApiDocsData.js Resolved

@shanpriyan shanpriyan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ovflowd
ovflowd merged commit b0e41c6 into main Mar 11, 2023
@ovflowd
ovflowd deleted the feat/merged-code-blocks branch March 11, 2023 05:51
@ovflowd

ovflowd commented Mar 11, 2023

Copy link
Copy Markdown
Member Author

HERE WE GO YALL

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

CJS and ESM examples are not unique and toggleable split

3 participants