shiki-templ

shiki-templ

 

shiki-templ provides a TextMate grammar definition for Templ, making it easier to use with Shiki. The grammar definition is taken from the official Templ grammar available at templ-go/playground. The goal of this package is not to define the grammar but to facilitate its use with Shiki.

This package supports both CommonJS and ESModule formats.

Installation

You can install the package using npm, pnpm, or yarn:

# npm
npm install shiki-templ

# pnpm
pnpm add shiki-templ

# yarn
yarn add shiki-templ

Usage

Shiki

To use the shiki-templ with Shiki, please refer to the official Load Custom Language page.

Vitepress

Here's how you can configure Vitepress to use the shiki-templ:

import { defineConfig } from "vitepress";
import { templLang } from "shiki-templ";

// https://vitepress.dev/reference/site-config
export default defineConfig({
    // ...
    markdown: {
        languages: [templLang],
    },
}):

License

This project is licensed under the MIT License - see the LICENSE file for details.