Twoslash

screenshot of Twoslash
docusaurus

You take some Shiki, add a hint of TypeScript compiler, and incredible static code samples

Overview:

The Twoslash repository has been relocated to twoslashes/twoslash with enhancements and restructuring. Integration with Shiki v1.0 can now be found in Shiki's monorepo as a transformer, enabling Twoslash functionality wherever Shiki is supported. This repository focuses on Shiki v0.x integration with Twoslash, combining Shiki and TypeScript compiler to produce visually appealing statically generated code samples.

Features:

  • Enhanced Compatibility: Twoslash now works seamlessly with Shiki v1.0, ensuring widespread compatibility.
  • Static Code Generation: Generates visually pleasing code samples using Shiki and TypeScript compiler.
  • Markdown Renderers Support: Supports various markdown renderers like Docusaurus, 11ty, Gatsby, Hexo, VuePress, Markdown-It, and Remark.
docusaurus
Docusaurus

Docusaurus is an open-source static site generator designed for creating documentation websites. Developed by Facebook, it simplifies the process of building, deploying, and maintaining documentation with its React-based framework and pre-configured setup for documentation projects.

typescript
Typescript

TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.