{"id":13406495,"url":"https://github.com/shikijs/twoslash","last_synced_at":"2025-05-14T21:06:12.334Z","repository":{"id":38306914,"uuid":"370944699","full_name":"shikijs/twoslash","owner":"shikijs","description":"You take some Shiki, add a hint of TypeScript compiler, and 🎉 incredible static code samples","archived":false,"fork":false,"pushed_at":"2024-02-19T12:13:47.000Z","size":6148,"stargazers_count":1124,"open_issues_count":65,"forks_count":54,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-05-11T11:37:35.131Z","etag":null,"topics":["docusaurus","javascript","markdown-it","markdown-it-plugin","remark","remark-plugin","shiki","shiki-twoslash","typescript"],"latest_commit_sha":null,"homepage":"https://shikijs.github.io/twoslash/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shikijs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-05-26T07:27:27.000Z","updated_at":"2025-05-11T11:14:08.000Z","dependencies_parsed_at":"2024-02-19T13:45:39.585Z","dependency_job_id":null,"html_url":"https://github.com/shikijs/twoslash","commit_stats":{"total_commits":340,"total_committers":34,"mean_commits":10.0,"dds":"0.34411764705882353","last_synced_commit":"f3a2683d1bd7fe64f424a808dcbdbc77b686c896"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shikijs%2Ftwoslash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shikijs%2Ftwoslash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shikijs%2Ftwoslash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shikijs%2Ftwoslash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shikijs","download_url":"https://codeload.github.com/shikijs/twoslash/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254227611,"owners_count":22035669,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docusaurus","javascript","markdown-it","markdown-it-plugin","remark","remark-plugin","shiki","shiki-twoslash","typescript"],"created_at":"2024-07-30T19:02:31.818Z","updated_at":"2025-05-14T21:06:12.250Z","avatar_url":"https://github.com/shikijs.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","Other","typescript"],"sub_categories":["Self-hosted"],"readme":"\u003e [!NOTE]\n\u003e 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.\n\u003e\n\u003e 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.\n\n\n\u003ccenter\u003e\u003cimg src=\"./misc/repo-icon.png\" /\u003e\u003c/center\u003e\n\nYou take some Shiki, add a hint of TypeScript compiler, and 🎉 incredible statically generated code samples.\n\nSee the user-facing docs at: https://shikijs.github.io/twoslash/\n\n### This Repo\n\nThe majority of this repo uses pnpm, the rest yarn. There are four main areas of interest:\n \n - `packages`, the shiki meets twoslash plugins for markdown renderers and static site generators\n - `site`, the docs micro-site\n - `examples`, example static site generator projects which use the plugins\n - `extensions`, right now, just the vscode extension for twoslash code samples\n \n### Packages\n\nThe `site` `extensions` and `examples` are excluded from the workspace. To work on those, `cd` to their folders and read instructions.\n\nOtherwise:\n\n```sh\ngit clone https://github.com/shikijs/twoslash\ncd twoslash\n\npnpm i\npnpm bootstrap\npnpm test\n```\n\nThen see the contributing [for advice](./CONTRIBUTING.md) and the vision file for the [long-term perspective](./VISION.md).\n\n#### Plugins \n\n- [`docusaurus-preset-shiki-twoslash`](packages/docusaurus-preset-shiki-twoslash) - for Docusaurus\n- [`eleventy-plugin-shiki-twoslash`](packages/eleventy-plugin-shiki-twoslash) - For 11ty\n- [`gatsby-remark-shiki-twoslash`](packages/gatsby-remark-shiki-twoslash) - For Gatsby\n- [`hexo-shiki-twoslash`](packages/hexo-shiki-twoslash) - For Hexo\n- [`vuepress-plugin-shiki-twoslash`](packages/vuepress-plugin-shiki-twoslash) - For VuePress\n\n#### Markdown Renderers\n\n- [`markdown-it-shiki-twoslash`](packages/markdown-it-shiki-twoslash) - For Markdown-It\n- [`remark-shiki-twoslash`](packages/remark-shiki-twoslash) - For Remark\n\n#### Root Abstractions\n\n- [`shiki-twoslash`](packages/shiki-twoslash) - Provides all the building blocks for above\n- [`twoslash-cli`](packages/twoslash-cli) - A CLI for converting md/ts/tsx/js/jsx files to HTML\n\n\n###### Deploys\n\nRun: `pnpm deploy`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshikijs%2Ftwoslash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshikijs%2Ftwoslash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshikijs%2Ftwoslash/lists"}