Skip to content

Conversation

@sanyuan0704
Copy link
Contributor

@sanyuan0704 sanyuan0704 commented May 23, 2023

Summary

🤖 Generated by Copilot at a915ac6

This pull request adds a new feature to the @modern-js/doc-core package that allows users to specify code titles in the MDX code blocks. It also updates the dependency version of @modern-js/mdx-rs-binding and enables the experimentalMdxRs option for the @modern-js/doc-tools documentation site. These changes improve the functionality, performance, and appearance of the code blocks in the documentation.

Details

🤖 Generated by Copilot at a915ac6

  • Add support for space in code title for @modern-js/doc-core package (link)
  • Update dependency version of @modern-js/mdx-rs-binding to use latest features and bug fixes of mdx-rs library (link)
  • Import and use rehypePluginCodeMeta plugin to extract meta information from code blocks and attach it to code node properties (link, link)
  • Implement rehypePluginCodeMeta plugin in codeMeta.ts file (link)
  • Delete preWrapper.ts file as it is no longer needed (link)
  • Define CodeProps interface and use it for Code component props in code.tsx file (link, link)
  • Add className attribute to code element in Code component for styling (link)
  • Import and use Pre component as a custom MDX component for pre element in index.tsx file (link, link)
  • Implement Pre component and parseTitleFromMeta helper function in pre.tsx file (link)
  • Enable experimentalMdxRs option in modern.config.ts file for @modern-js/doc-tools documentation site (link)

Related Issue

Checklist

  • I have added changeset via pnpm run change.
  • I have updated the documentation.
  • I have added tests to cover my changes.

@changeset-bot
Copy link

changeset-bot bot commented May 23, 2023

🦋 Changeset detected

Latest commit: 7521268

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 208 packages
Name Type
@modern-js/doc-core Patch
@modern-js/plugin-module-doc Patch
@modern-js/doc-tools Patch
integration-module-doc Patch
@modern-js/builder-doc Patch
@modern-js/doc-tools-doc Patch
@modern-js/main-doc Patch
@modern-js/module-tools-docs Patch
simple-doc-template Patch
i18n-doc Patch
doc-plugin Patch
simple-doc-production Patch
@modern-js/babel-preset-app Patch
@modern-js/babel-preset-base Patch
@modern-js/babel-preset-lib Patch
@modern-js/core Patch
@modern-js/doc-plugin-auto-sidebar Patch
@modern-js/doc-plugin-medium-zoom Patch
@modern-js/plugin-bff Patch
@modern-js/plugin-changeset Patch
@modern-js/plugin-data-loader Patch
@modern-js/plugin-i18n Patch
@modern-js/plugin-lint Patch
@modern-js/plugin-proxy Patch
@modern-js/plugin-ssg Patch
@modern-js/plugin-storybook Patch
@modern-js/plugin-swc Patch
@modern-js/plugin-tailwindcss Patch
@modern-js/plugin-garfish Patch
@modern-js/plugin-router-v5 Patch
@modern-js/runtime Patch
@modern-js/plugin-testing Patch
@modern-js/new-action Patch
@modern-js-app/eslint-config Patch
@modern-js/eslint-config Patch
@modern-js/tsconfig Patch
@modern-js/bff-core Patch
@modern-js/bff-runtime Patch
@modern-js/server-core Patch
@modern-js/create-request Patch
@modern-js/plugin-express Patch
@modern-js/plugin-koa Patch
@modern-js/plugin-polyfill Patch
@modern-js/plugin-server Patch
@modern-js/plugin-worker Patch
@modern-js/prod-server Patch
@modern-js/server Patch
@modern-js/server-utils Patch
@modern-js/builder-rspack-provider Patch
@modern-js/builder-shared Patch
@modern-js/builder-webpack-provider Patch
@modern-js/builder Patch
@modern-js/builder-plugin-esbuild Patch
@modern-js/builder-plugin-image-compress Patch
@modern-js/builder-plugin-node-polyfill Patch
@modern-js/builder-plugin-stylus Patch
@modern-js/builder-plugin-swc-base Patch
@modern-js/builder-plugin-swc Patch
@modern-js/plugin-module-babel Patch
@modern-js/plugin-module-banner Patch
@modern-js/plugin-module-import Patch
@modern-js/plugin-module-main-fields Patch
@modern-js/plugin-module-node-polyfill Patch
@modern-js/plugin-module-polyfill Patch
@modern-js/plugin-module-target Patch
@modern-js/app-tools Patch
@modern-js/module-tools Patch
@modern-js/monorepo-tools Patch
@modern-js/create Patch
@modern-js/e2e Patch
@modern-js/node-bundle-require Patch
@modern-js/plugin Patch
@modern-js/remark-container Patch
@modern-js/types Patch
@modern-js/upgrade Patch
@modern-js/utils Patch
@modern-js/babel-compiler Patch
@scripts/build Patch
@scripts/check-changeset Patch
@scripts/codemod Patch
@scripts/jest-config Patch
@scripts/lint-package-json Patch
@scripts/prebundle Patch
@scripts/update-codesmith Patch
@scripts/vitest-config Patch
tests Patch
@integration-test/alias-set Patch
api-service-koa Patch
app-docmuent Patch
integration-dev-asset-prefix Patch
integration-asset-prefix Patch
async-entry-test Patch
bff-express Patch
bff-koa Patch
integration-register-builder-plugins Patch
integration-builder-plugins Patch
builder-rspack Patch
integration-clean-dist-path Patch
integration-copy-public-html Patch
integration-copy-assets Patch
composes-basic Patch
composes-external Patch
dev-module Patch
global-module Patch
prod-module Patch
css Patch
antd-less Patch
bad-nested-npm-import Patch
bad-npm-import Patch
base-import Patch
disable-source-map Patch
exclude-less Patch
exclude-sass Patch
import-common-css Patch
less-import Patch
less-inline-js Patch
less-npm-import Patch
multi-css Patch
multi-less Patch
multi-sass Patch
nested-npm-import Patch
npm-import Patch
integration-tailwindcss-v2 Patch
integration-tailwindcss-v3 Patch
twin-macro-v2 Patch
twin-macro-v3 Patch
css-modules Patch
integration-custom-render Patch
integration-custom-template Patch
dev-server Patch
doc-tools Patch
legacy-esbuild-minify-js Patch
esbuild-transform-and-minify Patch
esbuild-integration Patch
@cypress-test/garfish-dashboard-router-v6 Patch
@cypress-test/garfish-dashboard Patch
@cypress-test/garfish-main-router-v6 Patch
@cypress-test/garfish-main-rspack Patch
@cypress-test/garfish-main Patch
@cypress-test/garfish-table Patch
integration-config-async-config-test Patch
integration-basic-local-config Patch
integration-config-function-params Patch
integration-local-config-function Patch
integration-load-config Patch
tmp Patch
nonce Patch
routes Patch
file-based-router Patch
use-loader Patch
runtime Patch
select-mul-entry-test Patch
select-one-entry-test Patch
entry Patch
server-config Patch
server-middleware Patch
server-hook-reqeust Patch
server-hook-response Patch
server-hook-router Patch
@integration-test/server-hook-reqeust Patch
server-prod Patch
ssg-fixtures-simple Patch
ssg-fixtures-web-server Patch
ssg Patch
ssr-base-json-test Patch
ssr-base-test Patch
init Patch
ssr-streaming-test Patch
ssr Patch
swc-minify-css Patch
swc-minify-js Patch
transform-fail Patch
swc-integration Patch
tmp-dir Patch
worker-test Patch
@e2e/webpack-builder-css-modules Patch
@e2e/webpack-builder-image-compress Patch
@e2e/webpack-builder-import-antd-v4 Patch
@e2e/webpack-builder-import-antd-v5 Patch
@e2e/webpack-builder-node-polyfill Patch
@e2e/builder-plugin-import Patch
@e2e/builder Patch
@modern-js/generator-common Patch
@modern-js/generator-plugin Patch
@modern-js/generator-utils Patch
@modern-js/bff-generator Patch
@modern-js/dependence-generator Patch
@modern-js/doc-generator Patch
@modern-js/entry-generator Patch
@modern-js/generator-generator Patch
@modern-js/module-generator Patch
@modern-js/module-test-generator Patch
@modern-js/monorepo-generator Patch
@modern-js/mwa-generator Patch
@modern-js/router-v5-generator Patch
@modern-js/rspack-generator Patch
@modern-js/ssg-generator Patch
@modern-js/storybook-generator Patch
@modern-js/test-generator Patch
@modern-js/upgrade-generator Patch
@modern-js/generator-plugin-plugin Patch
@modern-js/repo-generator Patch
@modern-js/generator-cases Patch
@modern-js/base-generator Patch
@modern-js/changeset-generator Patch
@modern-js/packages-generator Patch
@modern-js/server-generator Patch
@modern-js/tailwindcss-generator Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@sanyuan0704 sanyuan0704 force-pushed the feat/code-title-space branch from a915ac6 to d7eb34b Compare May 23, 2023 11:33
@codecov
Copy link

codecov bot commented May 23, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.58 🎉

Comparison is base (99693f0) 57.59% compared to head (f2931fc) 58.18%.

❗ Current head f2931fc differs from pull request most recent head 7521268. Consider uploading reports for the commit 7521268 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3744      +/-   ##
==========================================
+ Coverage   57.59%   58.18%   +0.58%     
==========================================
  Files         672      643      -29     
  Lines       17794    17185     -609     
  Branches     3876     3750     -126     
==========================================
- Hits        10249     9999     -250     
+ Misses       6934     6586     -348     
+ Partials      611      600      -11     

see 266 files with indirect coverage changes

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

@sanyuan0704 sanyuan0704 enabled auto-merge (squash) May 23, 2023 12:37
@sanyuan0704 sanyuan0704 changed the title feat(doc-core): support code title space (WIP)feat(doc-core): support code title space May 23, 2023
@sanyuan0704 sanyuan0704 force-pushed the feat/code-title-space branch from 007dea9 to f2931fc Compare May 23, 2023 12:50
@sanyuan0704 sanyuan0704 changed the title (WIP)feat(doc-core): support code title space feat(doc-core): support code title space May 23, 2023
@sanyuan0704 sanyuan0704 merged commit 0a6b969 into main May 23, 2023
@sanyuan0704 sanyuan0704 deleted the feat/code-title-space branch May 23, 2023 13:45
@caohuilin caohuilin mentioned this pull request May 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants