{"id":15413492,"url":"https://github.com/wooorm/markdown-tm-language","last_synced_at":"2025-04-13T18:37:24.148Z","repository":{"id":148009474,"uuid":"616601613","full_name":"wooorm/markdown-tm-language","owner":"wooorm","description":"really good syntax highlighting for markdown and MDX","archived":false,"fork":false,"pushed_at":"2024-11-11T13:03:35.000Z","size":747,"stargazers_count":45,"open_issues_count":3,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-27T09:21:19.389Z","etag":null,"topics":["highlight","markdown","mdx","syntax","tmlanguage","vs-code"],"latest_commit_sha":null,"homepage":"https://wooorm.com/markdown-tm-language/","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/wooorm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-03-20T17:54:19.000Z","updated_at":"2024-12-17T02:10:34.000Z","dependencies_parsed_at":"2023-05-28T06:30:17.234Z","dependency_job_id":"c6b3f480-f287-4524-91cd-e9b805a24494","html_url":"https://github.com/wooorm/markdown-tm-language","commit_stats":{"total_commits":63,"total_committers":1,"mean_commits":63.0,"dds":0.0,"last_synced_commit":"c4a90d34caa298ccd3652dee887b1981a4602f4b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fmarkdown-tm-language","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fmarkdown-tm-language/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fmarkdown-tm-language/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fmarkdown-tm-language/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wooorm","download_url":"https://codeload.github.com/wooorm/markdown-tm-language/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248762166,"owners_count":21157683,"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":["highlight","markdown","mdx","syntax","tmlanguage","vs-code"],"created_at":"2024-10-01T16:57:22.108Z","updated_at":"2025-04-13T18:37:24.118Z","avatar_url":"https://github.com/wooorm.png","language":"JavaScript","readme":"# markdown-tm-language\n\n[![Build][build-badge]][build]\n\nReally good syntax highlighting for [markdown][] and [MDX][].\n\n\u003ctable\u003e\n\u003ctr valign=\"middle\"\u003e\n\u003ctd align=\"center\"\u003e\n  \u003ca href=\"https://wooorm.com/markdown-tm-language/\"\u003e\u003cimg alt src=\"screenshot-md-dark.png\" width=\"650\"\u003e\u003c/a\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\n  Example of markdown highlighting (using GitHub dark mode theme)\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n\u003ctable\u003e\n\u003ctr valign=\"middle\"\u003e\n\u003ctd align=\"center\"\u003e\n  \u003ca href=\"https://wooorm.com/markdown-tm-language/\"\u003e\u003cimg alt src=\"screenshot-mdx-light.png\" width=\"650\"\u003e\u003c/a\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\n  Example of MDX highlighting (using GitHub light mode theme)\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## Contents\n\n* [What is this?](#what-is-this)\n* [When should I use this?](#when-should-i-use-this)\n* [Install](#install)\n  * [`starry-night`](#starry-night)\n  * [`shiki`](#shiki)\n  * [VS Code](#vs-code)\n  * [Sublime and TextMate](#sublime-and-textmate)\n* [Use](#use)\n* [API](#api)\n* [Syntax](#syntax)\n* [Compatibility](#compatibility)\n* [Security](#security)\n* [Related](#related)\n* [Contribute](#contribute)\n* [License](#license)\n\n## What is this?\n\nThis project includes high quality TextMate grammars for [markdown][] and\n[MDX][].\n\n[Try it out in the playground »][demo]\n\n## When should I use this?\n\nYou can use these grammars in your code editor or with\n[`starry-night`][starry-night] and [`shiki`][shiki].\n\n## Install\n\n### `starry-night`\n\nThese grammars are in [`github-linguist/linguist`][linguist],\nwhich means that they are also in [`starry-night`][starry-night].\n\n### `shiki`\n\nThese grammars are in [Shiki][].\n\n### VS Code\n\nFor the MDX grammar,\nuse: [`vscode-mdx`][vscode-mdx].\n\n### Sublime and TextMate\n\nI’m not a Sublime or TextMate user and I am not very interested in maintaining\na packages for them currently.\nYou should be able to clone this repo somewhere\n(`~/.config/sublime-text-2/Packages`?),\nthen you should reportedly be able to use these grammars.\n\nPR welcome to improve this section or do the work to make it happen :)\n\n## Use\n\nAfter installing, type some things!\n\nOr [use the playground][demo].\n\n## API\n\nThere is no API.\n\nYou can generate your own grammars, by modifying `languages` in `build.js`.\nTo illustrate, you can add a new `language` there, or turn on or off several\nextensions (such as `gfm`) in the existing ones.\n\n## Syntax\n\nMarkdown is handled according to CommonMark and common extensions:\n\n* directives\n* frontmatter (YAML, TOML)\n* GFM (autolink literals, footnotes, strikethrough, tables, tasklists)\n* GitHub (gemoji, mentions, references)\n* math\u003csup\u003e(†)\u003c/sup\u003e\n* MDX (ESM, expressions, JSX)\n\n\u003csup\u003e(†)\u003c/sup\u003e — with two or more dollars.\n\n## Compatibility\n\nThe markdown grammar supports CommonMark and common extensions: directives,\nfrontmatter, GFM, GitHub, and math.\nThe MDX grammar is similar, but of course uses the MDX syntax extensions, and\ndoes not include directives.\n\n## Security\n\nShould be good!\n\n## Related\n\n* [`micromark`](https://github.com/micromark/micromark)\n  — markdown parser in JavaScript\n* [`markdown-rs`](https://github.com/wooorm/markdown-rs)\n  — markdown parser in Rust\n\n## Contribute\n\nYes please!\nSee [How to Contribute to Open Source][contribute].\n\nIn particular, see `grammar.yml`, that’s likely where your changes will go,\nand it includes a ton of information on how it all works.\n\nYou might also want to check if the grammars here work with linguist.\nPerform these steps:\n\n```sh\ngit clone gh:github/linguist\ncd linguist\n./script/bootstrap\n# copy/paste this repo in `linguist`\nscript/grammar-compiler add markdown-tm-language\n```\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[author]: https://wooorm.com\n\n[build-badge]: https://github.com/wooorm/markdown-tm-language/workflows/main/badge.svg\n\n[build]: https://github.com/wooorm/markdown-tm-language/actions\n\n[contribute]: https://opensource.guide/how-to-contribute/\n\n[demo]: https://wooorm.com/markdown-tm-language/\n\n[license]: license\n\n[linguist]: https://github.com/github-linguist/linguist\n\n[markdown]: https://commonmark.org\n\n[mdx]: https://mdxjs.com\n\n[shiki]: https://github.com/shikijs/shiki\n\n[starry-night]: https://github.com/wooorm/starry-night\n\n[vscode-mdx]: https://github.com/mdx-js/mdx-analyzer/tree/main/packages/vscode-mdx\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fmarkdown-tm-language","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwooorm%2Fmarkdown-tm-language","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fmarkdown-tm-language/lists"}