From 42015c138b41f1618f0df74d72e8f3ecc8f844ef Mon Sep 17 00:00:00 2001 From: Anthony Fu Date: Mon, 19 Feb 2024 13:13:47 +0100 Subject: [PATCH] docs: add notice about this repo --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c0b8d6..f70a0cd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ +> [!NOTE] +> Twoslash has been moved to the new repository [twoslashes/twoslash](https://github.com/twoslashes/twoslash) with some refactoring and improvements. The Shiki v1.0 integration is now [in Shiki's monorepo](https://shiki.style/packages/twoslash) as a transformer, which means Twoslash will now work everywhere Shiki is supported. We will make Shiki supports more high-level tools so Twoslash could later inherit that. +> +> This repository is for Shiki v0.x integration with Twoslash. As we port more integrations to the new format, this repo will fade out gradually. + +
You take some Shiki, add a hint of TypeScript compiler, and 🎉 incredible statically generated code samples. @@ -51,4 +57,4 @@ Then see the contributing [for advice](./CONTRIBUTING.md) and the vision file fo ###### Deploys -Run: `pnpm deploy`. \ No newline at end of file +Run: `pnpm deploy`.