Merge pull request #9 from mintlify/sam/support-blade-syntax-highlighting

Support Blade (Laravel)

Author: dks333

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/mdx",
-  "version": "0.0.49",
+  "version": "0.0.54",
   "description": "Markdown parser from Mintlify",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/lib/syntaxHighlighting/blade.js

@@ -0,0 +1,69 @@
+/**
+ * Sources:
+ * 1. https://github.com/PrismJS/prism/blob/master/components/prism-php.js
+ * 2. https://github.com/Medalink/laravel-blade/blob/main/Syntaxes/Blade.sublime-syntax
+ * 3. https://github.com/miken32/highlightjs-blade/blob/main/src/languages/blade.js
+ */
+import refractorMarkup from 'refractor/lang/markup.js';
+import refractorPhp from 'refractor/lang/php.js';
+
+blade.displayName = 'blade';
+
+export default function blade(Prism) {
+  Prism.register(refractorMarkup);
+  Prism.register(refractorPhp);
+
+  (function (Prism) {
+    Prism.languages.blade = {
+      comment: /{{--([\s\S]*?)--}}/,
+
+      directive: {
+        pattern: /@\w+(?:::\w+)?(?:\s*\([\s\S]*?\))?/,
+        inside: {
+          keyword: /@\w+/,
+          function: /[:]\w+/,
+          punctuation: /[():]/,
+        },
+      },
+
+      echo: {
+        pattern: /\{{2,3}[\s\S]*?\}{2,3}/,
+        inside: {
+          delimiter: /^\{{2,3}|\}{2,3}$/,
+          php: {
+            pattern: /[\s\S]+/,
+            inside: Prism.languages.php,
+          },
+        },
+      },
+
+      php: {
+        pattern: /(?:\@php[\s\S]*?\@endphp|\<\?php[\s\S]*?\?\>)/,
+        inside: {
+          delimiter: {
+            pattern: /^\@php|\@endphp|\<\?php|\?\>$/,
+            alias: 'important',
+          },
+          php: {
+            pattern: /[\s\S]+/,
+            inside: Prism.languages.php,
+          },
+        },
+      },
+
+      markup: {
+        pattern: /<[^?]\/?(.*?)>/,
+        inside: Prism.languages.markup,
+      },
+
+      keyword:
+        /\b(?:@if|@else|@elseif|@endif|@foreach|@endforeach|@for|@endfor|@while|@endwhile|@unless|@endunless|@isset|@endisset|@empty|@endempty|@switch|@case|@break|@default|@endswitch|@include|@extends|@section|@endsection|@yield|@stack|@push|@endpush|@auth|@guest|@endauth|@endguest)\b/,
+
+      variable: /\$\w+/,
+
+      operator: /=>|->|\|\||&&|!=|==|<=|>=|[+\-*\/%<>]=?|\?:/,
+
+      punctuation: /[\[\](){}:;,]/,
+    };
+  })(Prism);
+}

src/plugins/rehype/rehypeSyntaxHighlighting.ts

@@ -6,6 +6,10 @@ import type { Node } from 'unist';
 import { Parent } from 'unist';
 import { visit } from 'unist-util-visit';
 
+import blade from '../../lib/syntaxHighlighting/blade.js';
+
+refractor.register(blade);
+
 export type RehypeSyntaxHighlightingOptions = {
   ignoreMissing?: boolean;
   alias?: Record<string, string[]>;