https://github.com/wevm/vitepress-plugin-shiki-twoslash

Static code examples for VitePress using Shiki Twoslash
https://github.com/wevm/vitepress-plugin-shiki-twoslash

docs shiki typescript vitepress

Last synced: 11 days ago
JSON representation

Static code examples for VitePress using Shiki Twoslash

• Host: GitHub
• URL: https://github.com/wevm/vitepress-plugin-shiki-twoslash
• Owner: wevm
• License: mit
• Archived: true
• Created: 2023-03-15T18:01:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-01T19:30:43.000Z (11 months ago)
• Last Synced: 2024-04-15T08:24:35.290Z (7 months ago)
• Topics: docs, shiki, typescript, vitepress
• Language: CSS
• Homepage: https://vitepress-twoslash.vercel.app
• Size: 362 KB
• Stars: 31
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vitepress-v1 - Static Code Samples with Twoslash - Display code samples on markdown using [Shiki Twoslash](https://github.com/shikijs/twoslash) (:electric_plug: Plugins / Community Plugins)

README

        
# VitePress Twoslash

Static code examples for [VitePress](https://vitepress.dev) using [Shiki Twoslash](https://github.com/shikijs/twoslash).

## Install

```bash

pnpm add vitepress-plugin-shiki-twoslash

```

```bash

npm i vitepress-plugin-shiki-twoslash

```

```bash

yarn add vitepress-plugin-shiki-twoslash

```

## Documentation

For full documentation, visit [vitepress-twoslash.vercel.app](https://vitepress-twoslash.vercel.app).

## Community

If you have questions or need help, reach out to the community at the [GitHub Discussions](https://github.com/wagmi-dev/vitepress-plugin-shiki-twoslash/discussions).

## Sponsor

If you find this library useful, please consider supporting development on [GitHub Sponsors](https://github.com/sponsors/wagmi-dev?metadata_campaign=twoslash_readme) or sending crypto to `wagmi-dev.eth`. Thank you 🙏

## Contributing

If you're interested in contributing, please read our [contributing docs](https://github.com/wagmi-dev/vitepress-plugin-shiki-twoslash/blob/main/.github/CONTRIBUTING.md) **before submitting a pull request**.