fix(website): migrate from @codehike/mdx to codehike 1.0.5 #1035
Conversation
youngjungithub
force-pushed
the
update-codespike
branch
from
9104fd2 to
726c426
Compare
youngjungithub
force-pushed
the
update-codespike
branch
from
726c426 to
c4fa048
Compare
youngjungithub
force-pushed
the
update-codespike
branch
3 times, most recently
from
da25aa3 to
f8042f5
Compare
youngjungithub
force-pushed
the
update-codespike
branch
from
f8042f5 to
0e4ab5b
Compare
youngjungithub
changed the title
This commit updates our documentation site to use the official `codehike` package (v1.0.5)
instead of the deprecated `@codehike/mdx`. The CodeHike project has consolidated all
functionality into the main `codehike` package, discontinuing support for the separate
`@codehike/mdx` package.
Changes include:
- Updated package.json dependencies to use `codehike@^1.0.5`
- Removed the deprecated `@codehike/mdx` dependency
- Updated import statements in docusaurus.config.js to use the new module path:
`const { remarkCodeHike, recmaCodeHike } = require('codehike/mdx')`
- Replaced the incompatible shiki/nord.json theme with 'github-dark'
- Updated MDX configuration to align with the new CodeHike API
- Adjusted code block syntax in documentation files to work with the new version
This migration ensures our documentation site continues to have proper syntax highlighting
and code examples while staying current with the CodeHike ecosystem. The github-dark theme
provides excellent readability and maintains visual consistency.
chore: nix fix
youngjungithub
force-pushed
the
update-codespike
branch
from
2f52783 to
08f01e9
Compare
|
Note for the reviewer: There is a small visual discrepancy in the UI on one specific article which will be fixed in a separate, follow-up PR. This allows the current PR to focus solely on the migration task and simplifies the review. Before.movAfter: After.mov |
|
🎉 This PR is included in version @api-ts/typed-express-router@2.0.0-beta.1 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/express-wrapper@2.0.0-beta.1 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/typed-express-router@1.1.14 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/express-wrapper@1.0.34 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/superagent-wrapper@1.3.4 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version @api-ts/openapi-generator@5.8.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
3 participants
This PR updates our documentation site to use the official
codehikepackage (v1.0.5)instead of the deprecated
@codehike/mdx. The CodeHike project has consolidated allfunctionality into the main
codehikepackage, discontinuing support for the separate@codehike/mdxpackage.Changes include:
codehike@^1.0.5@codehike/mdxdependencyconst { remarkCodeHike, recmaCodeHike } = require('codehike/mdx')This migration ensures our documentation site continues to have proper syntax highlighting
and code examples while staying current with the CodeHike ecosystem. The github-dark theme
provides excellent readability and maintains visual consistency.