{"id":15021005,"url":"https://github.com/linjer/jekyll-katex","last_synced_at":"2025-04-06T18:17:10.934Z","repository":{"id":48768049,"uuid":"69832458","full_name":"linjer/jekyll-katex","owner":"linjer","description":"[DEPRECATED] Jekyll plugin for easy server-side math rendering via KaTeX","archived":false,"fork":false,"pushed_at":"2024-05-16T19:11:02.000Z","size":330,"stargazers_count":97,"open_issues_count":14,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T16:12:41.180Z","etag":null,"topics":["github-pages","jekyll","jekyll-katex","jekyll-plugin","katex","latex"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/linjer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2016-10-03T01:22:32.000Z","updated_at":"2025-03-12T15:22:25.000Z","dependencies_parsed_at":"2024-10-11T09:40:55.938Z","dependency_job_id":"5c8413e5-b014-496c-8348-d68cb17321a3","html_url":"https://github.com/linjer/jekyll-katex","commit_stats":{"total_commits":36,"total_committers":6,"mean_commits":6.0,"dds":0.3055555555555556,"last_synced_commit":"419235cabe4a6e89754973dbc767bdbd73757f08"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linjer%2Fjekyll-katex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linjer%2Fjekyll-katex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linjer%2Fjekyll-katex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linjer%2Fjekyll-katex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linjer","download_url":"https://codeload.github.com/linjer/jekyll-katex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526768,"owners_count":20953143,"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":["github-pages","jekyll","jekyll-katex","jekyll-plugin","katex","latex"],"created_at":"2024-09-24T19:56:00.323Z","updated_at":"2025-04-06T18:17:10.908Z","avatar_url":"https://github.com/linjer.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jekyll-katex\n\n[![Build Status](https://travis-ci.com/linjer/jekyll-katex.svg?branch=master)](https://travis-ci.com/linjer/jekyll-katex)\n[![Latest Release](https://badge.fury.io/rb/jekyll-katex.svg)](https://badge.fury.io/rb/jekyll-katex)\n\nThis is a [Jekyll](http://jekyllrb.com) plugin for performing compile-time math rendering via the [KaTeX](https://github.com/Khan/KaTeX) library.\nKaTeX is a library for rending math on the web using LaTeX, similar to MathJax.\n\nKaTeX differs from MathJax in that it displays faster rendering speed and renders to pure HTML rather than PNGs.\nThere are various resources in benchmarking and comparing their performance, for more info, [start here](https://khan.github.io/KaTeX/).\n\nComes packaged with KaTeX `0.11.1` but you can specify a different version in your Jekyll `_config.yml` (see below).\n\n## Installation\n\n\n1. In your Jekyll project, add the plugin to your `_config.yml`, e.g.:\n\n    ```yaml\n    plugins:\n      - jekyll-katex\n    ```\n\n2. Add `jekyll-katex` to your `gems.rb`/`Gemfile` plugin block:\n\n    ```ruby\n    group :jekyll_plugins do\n      gem 'jekyll-katex'\n    end\n    ```\n\n    Once done, execute `bundle install`.\n\n3. Add KaTeX CSS and Fonts. Follow the installation instructions on the [KaTeX README](https://github.com/Khan/KaTeX).\n    You can skip including the `.js` file unless you want to do client-side in-browser rendering, as well.\n\n    Put the following (adjusting for your version) in your page headers:\n\n    ```html\n    \u003clink rel=\"stylesheet\" href=\"https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.css\" integrity=\"sha384-zB1R0rpPzHqg7Kpt0Aljp8JPLqbXI3bhnPWROx27a9N0Ll6ZP/+DiW/UqRcLbRjq\" crossorigin=\"anonymous\"\u003e\n    ```\n\n## Configuration\n\nSupported configuration values, shown with default values:\n\n```yml\nkatex:\n  js_path: \"{{ Gem::lib_path }}/assets/js\"  # Path used to search for katex.min.js\n  rendering_options:\n    # Default KaTeX rendering options. See https://github.com/Khan/KaTeX#rendering-options\n    throw_error: true                       # throwOnError - set to false if you want rendering to output error as text rather than a build error\n    error_color: \"#cc0000\"                  # errorColor\n```\n\n## Usage\n\nThere are two liquid tags: `katex` and `katexmm`.\n\n### katex\n\nUse the `katex` liquid tag for LaTeX math equations like so:\n\n```latex\n{% katex %}\nc = \\pm\\sqrt{a^2 + b^2}\n{% endkatex %}\n```\n\nIf you want the equation to be rendered in display mode (on its own line, centered, large symbols), just pass in the `display` parameter:\n\n```latex\n{% katex display %}\nc = \\pm\\sqrt{a^2 + b^2}\n{% endkatex %}\n```\n\n### katexmm\n\nThe `katex` liquid tag can be cumbersome, particularly if you have many inline blocks, which would need to be opened\nand closed repeatedly, cluttering the source text. `katexmm` is an alternative that supports fenced math mode blocks\nsimilar to standard latex:\n\n```latex\n{% katexmm %}\nThis is a mixed environment where you can have normal text and $c = \\pm\\sqrt{a^2 + b^2}$ fenced math. \\$!\n{% endkatexmm %}\n```\n\n* `$` for inline\n* `$$` for display mode\n* `\\$` to escape `$` anywhere within the `katexmm` environment\n\n## Development\n\n```bash\n$ bundle install\n$ rake build\n```\n\n## Contributing\n\nFeel free to open issues and pull requests.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinjer%2Fjekyll-katex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinjer%2Fjekyll-katex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinjer%2Fjekyll-katex/lists"}