\n\tDemo |\n\tWiki |\n\tDocs\n
\n\n\n\n- ๐ชถ Lightweight (**~2kB** for the core + **~1kB** by language)\n- โก Fast (faster than prism and highlight.js on average)\n- ๐งน Minimal Codebase\n\n## Simple setup ๐\n\n### Web\n\nStyle/theme (in the header of your html file):\n\n```html\n\n```\n\nIn the body of your html file:\n\n```html\n[inline code]\n```\n\nHighlight the code (in your javascript):\n\n```js\nimport { highlightAll } from '/path/dist/index.js';\nhighlightAll();\n```\n\nAuto language detection\n\n```js\nimport { highlightElement } from '../dist/index.js';\nimport { detectLanguage } from '../dist/detect.js';\n\nelm.textContent = code;\nhighlightElement(elm, detectLanguage(code));\n```\n\nLoad custom language\n\n```js\nimport { loadLanguage } from '../dist/index.js';\n\nloadLanguage('language-name', customLanguage);\n```\n\n---\n\n#### CDN\n\n```html\n\n\n```\n\n```js\nimport ... from 'https://unpkg.com/@speed-highlight/core/dist/index.js';\nimport ... from 'https://cdn.jsdelivr.net/gh/speed-highlight/core/dist/index.js';\n```\n\n---\n\n### Deno\n\nUse the [deno module](https://deno.land/x/speed_highlight_js)\n\n```js\nimport { setTheme, printHighlight } from 'https://deno.land/x/speed_highlight_js/dist/terminal.js';\n\nawait setTheme('[theme-name]');\nprintHighlight('console.log(\"hello\")', 'js');\n```\n\n---\n\n### Node\n\nUse the [npm package](https://www.npmjs.com/package/@speed-highlight/core)\n\n```bash\nnpm i @speed-highlight/core\n```\n\n```js\nconst { setTheme, printHighlight } = require('@speed-highlight/core/terminal');\n\nsetTheme('[theme-name]');\nprintHighlight('console.log(\"hello\")', 'js');\n```\n\n## Migrating from prism\n\nSpeed-highlight JS is a lighter and faster version of prism that share a similar API\n\n### Style\n\nRemove the prism stylesheet in the head of your html file\nClone this repository or use a cdn to load our stylesheet\n\n```diff\n\n- \n+ \n\n```\n\n### Script\n\nFor the script part remove the prism.js script and replace it by a import and a call to `highlightAll`\n\n```diff\n\n- \n+\n\n```\n\nIf you want to highlight only a specific element you can use the `highlightElement` function instead\n\n### Code block\n\nFor the code blocks replace the `` by only one ``\nAnd use `shj-lang-` prefix instead of `language-` for the class property\n\n```diff\n-p { color: red }
\n+p { color: red }\n```\n\nAnd for inline code block you just have to change the class property\n\n```diff\n-p { color: red }\n+p { color: red }\n```\n\n## Languages supported ๐\n\n| Name | Class name | Support | Language detection |\n| ---------- | ------------------- | --------------------------------------------------- | ------------------ |\n| asm | shj-lang-asm | | โ
|\n| bash | shj-lang-bash | | โ
|\n| brainfuck | shj-lang-bf | increment, operator, print, comment | โ |\n| c | shj-lang-c | | โ
|\n| css | shj-lang-css | comment, str, selector, units, function, ... | โ
|\n| csv | shj-lang-csv | punctuation, ... | โ |\n| diff | shj-lang-diff | | โ
|\n| docker | shj-lang-docker | | โ
|\n| git | shj-lang-git | comment, insert, deleted, string, ... | โ |\n| go | shj-lang-go | | โ
|\n| html | shj-lang-html | | โ
|\n| http | shj-lang-http | keywork, string, punctuation, variable, version | โ
|\n| ini | shj-lang-ini | | โ |\n| java | shj-lang-java | | โ
|\n| javascipt | shj-lang-js | basic syntax, regex, jsdoc, json, template literals | โ
|\n| jsdoc | shj-lang-jsdoc | | โ |\n| json | shj-lang-json | string, number, bool, ... | โ |\n| leanpub-md | shj-lang-leanpub-md | | โ |\n| log | shj-lang-log | number, string, comment, errors | โ |\n| lua | shj-lang-lua | | โ
|\n| makefile | shj-lang-make | | โ
|\n| markdown | shj-lang-md | | โ
|\n| perl | shj-lang-pl | | โ
|\n| plain | shj-lang-plain | | โ |\n| python | shj-lang-py | | โ
|\n| regex | shj-lang-regex | count, set, ... | โ |\n| rust | shj-lang-rs | | โ
|\n| sql | shj-lang-sql | number, string, function, ... | โ
|\n| todo | shj-lang-todo | | โ |\n| toml | shj-lang-toml | comment, table, string, bool, variable | โ |\n| typescript | shj-lang-ts | js syntax, ts keyword, types | โ
|\n| uri | shj-lang-uri | | โ
|\n| xml | shj-lang-xml | | โ
|\n| yaml | shj-lang-yaml | comment, numbers, variable, string, bool | โ |\n\n## Themes ๐\n\nA modern theme by default\n\n| Name | Terminal | Web |\n| ------------------- | -------- | --- |\n| default | โ
| โ
|\n| github-dark | โ | โ
|\n| github-light | โ | โ
|\n| github-dim | โ | โ
|\n| atom-dark | โ
| โ
|\n| visual-studio-dark | โ | โ
|\n","readmeFilename":"README.md"}