shiki-templ

shiki-templ

Enabling Templ syntax highlighting in Shiki.

 

shiki-templ makes easier to use the TextMate grammar definition for Templ with Shiki.

The package tries to fetch the online version of the grammar file to get the latest available and, if it fails, uses a local version as a fallback.

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.

Changelog

v0.2.1

🩹 Fixes

• Dynamically import Node.js modules only if running in a Node.js environment (isNode is true). (e60646a)

🏡 Chore

• package.json: Bump packageManager to pnpm@9.1.4 (57adebc)

❤️ Contributors

• Indaco [e-mail]