Skip to content

GitHub Block to embed a TypeScript Playground in Markdown files or as a custom file renderer in GitHub

License

Notifications You must be signed in to change notification settings

HiDeoo/ts-playground-block

Repository files navigation

ts-playground-block 🔭

Embed a TypeScript Playground in GitHub

Features

A GitHub Block to embed a TypeScript Playground in Markdown files or as a custom file renderer in GitHub.

Warning

GitHub Blocks is currently an experimental technical preview and may change at any time.

Planned Features

GitHub Blocks is still in early development and same goes for this GitHub Block. The following features are planned:

  • TS Config customization just like the official TypeScript Playground.
  • Theme support (the GitHub Blocks UI does not yet support themes).

Limitations

It is currently not possible to customize the options, e.g. the TypeScript version, of the TypeScript Playground GitHub Block directly from Markdown but some sort of "instance" state allowing this kind of customization is on the roadmap.

Examples

Embedded in a README file.

As a file renderer for a TypeScript file.

As a file renderer for a TypeScript file with a specific TypeScript version.

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.

About

GitHub Block to embed a TypeScript Playground in Markdown files or as a custom file renderer in GitHub

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published