sass-site/source/helpers/components/index.ts

import {highlight, languages} from 'prismjs';
import PrismLoader from 'prismjs/components/index';

import {liquidEngine} from '../engines';
import {stripIndent} from '../type';
import {default as codeExample} from './codeExample';
import {compatibility, implStatus} from './compatibility';
import {getDocTocData, getToc} from './toc';

export {codeExample};
export {compatibility, implStatus};
export {getDocTocData, getToc};

/**
 * Returns HTML for a fun fact that's not directly relevant to the main
 * documentation.
 */
export const funFact = async (contents: string) =>
  liquidEngine.renderFile('fun_fact', {
    contents: stripIndent(contents),
  });

/**
 * Returns HTML for a heads-up warning related to the main documentation.
 */
export const headsUp = async (contents: string) =>
  liquidEngine.renderFile('heads_up', {
    contents: stripIndent(contents),
  });

/**
 * Returns HTML for a code block with syntax highlighting via [Prism][].
 *
 * This should be equivalent to the [11ty `{% highlight %}` tag][hl-tag], except
 * this tag can wrap dynamic content (partials, variables, etc), while the 11ty
 * tag only wraps plain text.
 *
 * [Prism]: https://prismjs.com/
 * [hl-tag]: https://www.11ty.dev/docs/plugins/syntaxhighlight/#usage
 *
 * @see https://prismjs.com/
 */
export const codeBlock = (contents: string, language: string, padding = 0) => {
  if (!languages[language]) {
    PrismLoader(language);
  }
  const code = `${contents}${'\n'.repeat(padding + 1)}`;
  const html = highlight(code, languages[language], language);
  const attr = `language-${language}`;
  return `<pre class="${attr}"><code class="${attr}">${html.replaceAll(
    '\n',
    '&#10;'
  )}</code></pre>`;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
export default function componentsPlugin(eleventyConfig: any) {
  // filters...
  eleventyConfig.addLiquidFilter('implStatus', implStatus);
  eleventyConfig.addLiquidFilter('getDocTocData', getDocTocData);
  eleventyConfig.addLiquidFilter('getToc', getToc);

  // paired shortcodes...
  eleventyConfig.addPairedLiquidShortcode('code', codeBlock);
  eleventyConfig.addPairedLiquidShortcode('codeExample', codeExample);
  // Ideally this could be used with named args, but that's not supported yet in
  // 11ty's implementation of LiquidJS:
  // https://github.com/11ty/eleventy/issues/2679
  // In the meantime, check the order in the function definition of
  // `compatibility` in `source/helpers/components/compatibility.ts`.
  eleventyConfig.addPairedLiquidShortcode('compatibility', compatibility);
  eleventyConfig.addPairedLiquidShortcode('funFact', funFact);
  eleventyConfig.addPairedLiquidShortcode('headsUp', headsUp);
}