{"id":15288236,"url":"https://github.com/bradhowes/remarkable-katex","last_synced_at":"2025-10-11T04:59:54.549Z","repository":{"id":56642844,"uuid":"94039008","full_name":"bradhowes/remarkable-katex","owner":"bradhowes","description":"A Remarkable plugin for converting $...$ and $$...$$ in Markdown text into math HTML using KaTeX.","archived":false,"fork":false,"pushed_at":"2024-04-24T19:54:28.000Z","size":46,"stargazers_count":23,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T02:56:56.276Z","etag":null,"topics":["katex","latex","math-html","remarkable","remarkable-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bradhowes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"bradhowes"}},"created_at":"2017-06-11T23:55:59.000Z","updated_at":"2024-06-18T19:46:33.159Z","dependencies_parsed_at":"2024-04-24T20:33:37.479Z","dependency_job_id":"120e0fba-72d9-411b-b712-f997f49f70d6","html_url":"https://github.com/bradhowes/remarkable-katex","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bradhowes%2Fremarkable-katex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bradhowes%2Fremarkable-katex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bradhowes%2Fremarkable-katex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bradhowes%2Fremarkable-katex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bradhowes","download_url":"https://codeload.github.com/bradhowes/remarkable-katex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248642511,"owners_count":21138351,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["katex","latex","math-html","remarkable","remarkable-plugin"],"created_at":"2024-09-30T15:44:51.110Z","updated_at":"2025-10-11T04:59:49.509Z","avatar_url":"https://github.com/bradhowes.png","language":"JavaScript","funding_links":["https://github.com/sponsors/bradhowes"],"categories":[],"sub_categories":[],"readme":"[![CI](https://github.com/bradhowes/remarkable-katex/workflows/CI/badge.svg)](https://github.com/bradhowes/remarkable-katex)\n[![License: MIT](https://img.shields.io/badge/License-MIT-A31F34.svg)](https://opensource.org/licenses/MIT)\n\n# Overview\n\nThis is a [Remarkable](https://github.com/jonschlinkert/remarkable) plugin that converts\n[LaTeX math expressions](http://web.ift.uib.no/Teori/KURS/WRK/TeX/symALL.html) between `$...$` (inline) or\n`$$...$$` (block) delimiters into math HTML. It should not interfere with any other Markdown processing.\n\nI use this to perform server-side math expression rendering for my blog, [Keystroke\nCountdown](https://keystrokecountdown.com). The post \n[Metalsmith Plugins for Server-side KaTeX Processing](https://keystrokecountdown.com/articles/metalsmith2/index.html)\ntalks about the implementation of this package as well as a Jupyter IPython notebook plugin that does \nsimilar processing.\n\n# To Use\n\nInstall this package using `npm`:\n\n```bash\n% npm install [-s] remarkable-katex\n```\n\nAssuming you already have `Remarkable` installed, one way to use would be like so:\n\n**CommonJS**\n```javascript\nconst { Remarkable, utils } = require('remarkable');\nconst plugin = require('remarkable-katex');\nconst md = new Remarkable();\nmd.use(plugin, {delimiter: ''});\n```\n\n**ES6**\n```javascript\nimport { Remarkable, utils } from 'remarkable';\nimport { rkatex } from 'remarkable-katex';\n\nconst md = new Remarkable();\nmd.use(rkatex, {delimiter: ''});\n```\n\n# Configuration\n\nAccepts a `delimiter` option that defines the 1-character delimiter to use when recognizing KaTeX spans. Default\nis the `$` character.\n\n```\n{delimiter: '$'}\n```\n\n# Dependencies\n\n* [KaTeX](https://github.com/Khan/KaTeX) -- performs the rendering of the LaTeX commands.\n\n# Tests\n\nThere are a set of [Vows](http://vowsjs.org) in [index.test.js](index.test.js). To run:\n\n```bash\n% npm test\n```\n\n\u003e **NOTE**: if this fails, there may be a path issue with `vows` executable. See [package.json](package.json).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbradhowes%2Fremarkable-katex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbradhowes%2Fremarkable-katex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbradhowes%2Fremarkable-katex/lists"}