[{"_1":2,"_174":-5,"_175":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_153":154},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":84,"_108":109,"_146":-5,"_147":11,"_148":17,"_149":11,"_150":-5,"_151":152},"canonicalUrl","https://hub.docker.com/r/chialab/math-api/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","chialab","reponame","math-api","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2019-05-17T07:34:00.765366Z","description","API to render maths using MathJax for Node.","is_private","last_updated","2020-03-15T16:12:31.171898Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",10231,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

\n \n $\"Math$ \n \n

\n\n

\n Math API • Render LaTeX and MathML formulas as SVG or PNG.\n

\n\n---\n\nA REST API to do fancy things with formulas, like rendering LaTeX or MathML to\nSVG or PNG on the server side using [MathJax for Node](https://github.com/mathjax/MathJax-node),\nwhile leveraging expensive computations on the client.\n\n## As a Serverless application\n\nYou can deploy this repository as a serverless application using an AWS CloudFormation\nTemplate to create an AWS API Gateway that invokes Lambda functions to serve requests.\n\n> [**Launch this stack on AWS**](https://console.aws.amazon.com/cloudformation/home#/stacks/new?stackName=MathApi&templateURL=https://chialab-cloudformation-templates.s3-eu-west-1.amazonaws.com/chialab/math-api/master/template.yml)\n\n## As a Docker image\n\nYou can pull and run a Docker container to deploy the API on your local machine,\nserver, Kubernetes cluster, whatever!\n\nTo start the container (it will bind on ):\n\n```sh\ndocker run --name math-api -d -p 3000:3000 chialab/math-api\n```\n\n## Endpoints\n\n- [`GET /render`](#get-render)\n- [`POST /render`](#post-render)\n\n### `GET /render`\n\n> An endpoint to render LaTeX and MathML formulas to SVG or PNG.\n\n**Query parameters**:\n\n- `input` (**required**): the format of math in input. \n **Valid values**: `latex`, `mathml`\n- `inline` (_optional_): when `input` is `latex`, optionally enable \"inline\" mode. \n **Valid values**: `0`, `1`\n- `source` (**required**): the math to be rendered. \n **Valid values**: _string, depends on the input type_\n- `output` (**required**): the output format. \n **Valid values**: `mathml`, `png`, `svg`\n- `width`, `height` (_optional_): when `output` is `png`, specify the dimensions of the image to return. \n **Valid values**: _positive integers_\n\n**Examples**:\n\n```http\nGET /render?input=latex&output=svg&source=x^2 HTTP/1.1\nAccept: image/svg+xml\n```\n\n```http\nGET /render?input=latex&inline=1&output=png&source=x^2&width=512 HTTP/1.1\nAccept: image/png\n```\n\n### `POST /render`\n\n> An endpoint to render LaTeX and MathML formulas to SVG or PNG.\n\n**Request body (JSON)**:\n\n- `input` (**required**): the format of math in input. \n **Valid values**: `latex`, `mathml`\n- `inline` (_optional_): when `input` is `latex`, optionally enable \"inline\" mode. \n **Valid values**: _boolean_\n- `source` (**required**): the math to be rendered. \n **Valid values**: _string, depends on the input type_\n- `output` (**required**): the output format. \n **Valid values**: `mathml`, `png`, `svg`\n- `width`, `height` (_optional_): when `output` is `png`, specify the dimensions of the image to return. \n **Valid values**: _positive integers_\n\n**Examples**:\n\n```http\nPOST /render\nAccept: image/svg+xml\nContent-Type: application/json\n\n{\n \"input\": \"latex\",\n \"output\": \"svg\",\n \"source\": \"e^{i \\\\pi} + 1 = 0\"\n}\n```\n\n```http\nPOST /render\nAccept: image/png\nContent-Type: application/json\n\n{\n \"input\": \"latex\",\n \"inline\": true,\n \"output\": \"png\",\n \"source\": \"e^{i \\\\pi} + 1 = 0\",\n \"width\": 512\n}\n```\n\n## Development\n\n_All the following instructions assume you have at least [NodeJS](https://nodejs.org/) and [Yarn](https://yarnpkg.com/) installed._\n\n**Start the application locally**:\n> `yarn start`\n\n**Run unit tests**:\n> `yarn run test`\n\n**Start a simulated AWS API Gateway** (_provided you have AWS SAM Local and Docker installed_):\n> `yarn run api-gateway`\n\n**Validate CloudFormation template** (_provided you have AWS CLI installed_)\n> `make validate`\n\n**Package CloudFormation template** (_provided you have AWS CLI and Docker installed_)\n> `make layers` (_this is needed only the first time, then when updating MathJax version_)\n> `make package`\n\n**Deploy CloudFormation template** (_provided you have AWS CLI and Docker installed_)\n> `make deploy`\n> `make deploy ENVIRONMENT=Production`\n\n---\n\n## License\n\nMath API is released under the [MIT](https://github.com/chialab/math-api/blob/master/LICENSE) license.\n","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",654305653,"orgData",{"_85":86,"_87":88,"_89":90,"_91":28,"_92":93,"_94":95,"_96":97,"_98":99,"_100":101,"_102":103,"_104":105,"_106":105,"_107":17},"id","fb0b31984e2b45d491f13b35ad06173c","uuid","fb0b3198-4e2b-45d4-91f1-3b35ad06173c","type","organization","orgname","full_name","Chialab s.r.l.","location","Bologna, Italy","company","Chialab","profile_url","https://www.chialab.it","date_joined","2015-10-13T16:22:49.670995Z","gravatar_url","https://www.gravatar.com/avatar/f18a8ceabb52378dd7bad7c893c1afe5?s=80&r=g&d=mm","gravatar_email","","badge","is_active","recentTags",[110],{"_111":39,"_112":113,"_114":115,"_85":116,"_117":118,"_45":135,"_136":113,"_137":28,"_138":51,"_52":139,"_140":141,"_142":126,"_143":135,"_144":61,"_145":17},"content_type","creator",471711,"full_size",395193432,56052603,"images",[119],{"_120":121,"_122":123,"_124":105,"_125":126,"_127":128,"_129":130,"_131":105,"_132":-5,"_133":115,"_58":61,"_134":-5},"architecture","amd64","digest","sha256:61fd8f15a685fe4df89b107bf00b80ff9d5f4a93a3685055c3eb9e943fe0dbec","features","last_pulled","2026-09-16T12:22:24.336380731Z","last_pushed","2020-03-15T16:12:31Z","os","linux","os_features","os_version","size","variant","2020-03-15T16:12:30.77856Z","last_updater","last_updater_username","media_type","latest","repository",7132212,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":155,"_162":163,"_151":172,"_173":11},{"_35":156,"_37":157,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":158,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":159,"_74":11,"_75":161,"_80":28,"_81":82},[],[39],[51],{"_70":11,"_71":160},[73],{"_77":17,"_78":11,"_79":11},"tags",{"_164":59,"_165":-5,"_166":-5,"_167":168},"count","next","previous","results",[169],{"_111":39,"_112":113,"_114":115,"_85":116,"_117":170,"_45":135,"_136":113,"_137":28,"_138":51,"_52":139,"_140":141,"_142":126,"_143":135,"_144":61,"_145":17},[171],{"_120":121,"_122":123,"_124":105,"_125":126,"_127":128,"_129":130,"_131":105,"_132":-5,"_133":115,"_58":61,"_134":-5},[],"canDeleteTags","actionData","errors"]

chialab/math-api

Tags for chialab/math-api