docs / welcome.md
twinkleplop
A syntax highlighter and code authoring toolkit. Small, fast, customisable. plop it in and twinkle.
# quick links § 01
01 › quick start install and twinkle02 › themes light and dark03 › customization make it your own04 › faq no-one actually asked
# try it live § 03
Edit the source and watch it re-twinkle in real-time. This is a scaled-down embed of the lab where you can every language and theme in the browser.
mini-lab · editable github-dark · typescript
twinkled in 0.000ms 0 tokens · 0 lines
# hello, twinkle § 04
Get started in a few lines. Drop this in a browser or Node:
first-twinkle.ts typescript copy
import { language } from "@twinkleplop/typescript";
import "@twinkleplop/theme-github";
const typescript = language();
const html = typescript("1 + 2");