docusaurus-preset-shiki-twoslash
Advanced tools
Comparing version 1.0.4 to 1.1.0
{ | ||
"name": "docusaurus-preset-shiki-twoslash", | ||
"version": "1.0.4", | ||
"version": "1.1.0", | ||
"license": "MIT", | ||
@@ -25,5 +25,5 @@ "homepage": "https://github.com/shikijs/twoslash", | ||
"dependencies": { | ||
"remark-shiki-twoslash": "1.3.0", | ||
"remark-shiki-twoslash": "1.4.2", | ||
"typescript": ">3" | ||
} | ||
} |
@@ -25,19 +25,3 @@ ### Docusaurus Preset Shiki Twoslash | ||
1. Add the CSS from [npmjs.com/package/remark-shiki-twoslash](https://www.npmjs.com/package/remark-shiki-twoslash) to `src/css/custom.css` | ||
1. Add the JS via a [root component](https://docusaurus.io/docs/using-themes#wrapper-your-site-with-root): `src/theme/Root.js` | ||
```ts | ||
import React, { useEffect } from "react" | ||
import { setupTwoslashHovers } from "shiki-twoslash/dist/dom" | ||
// Default implementation, that you can customize | ||
function Root({children}) { | ||
useEffect(setupTwoslashHovers, []) | ||
return <>{children}</>; | ||
} | ||
export default Root; | ||
``` | ||
1. Disable the in-built formatter: `src/theme/MDXComponents/index.js`: | ||
@@ -44,0 +28,0 @@ |
8235
41
+ Addedregenerator-runtime@0.13.11(transitive)
+ Addedremark-shiki-twoslash@1.4.2(transitive)
+ Addedshiki-twoslash@1.4.1(transitive)
- Removedremark-shiki-twoslash@1.3.0(transitive)
- Removedshiki-twoslash@1.3.1(transitive)
Updatedremark-shiki-twoslash@1.4.2