Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wooorm/markdown-tm-language
really good syntax highlighting for markdown and MDX
https://github.com/wooorm/markdown-tm-language
highlight markdown mdx syntax tmlanguage vs-code
Last synced: 13 days ago
JSON representation
really good syntax highlighting for markdown and MDX
- Host: GitHub
- URL: https://github.com/wooorm/markdown-tm-language
- Owner: wooorm
- License: mit
- Created: 2023-03-20T17:54:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-24T09:36:14.000Z (20 days ago)
- Last Synced: 2024-10-25T07:19:18.548Z (19 days ago)
- Topics: highlight, markdown, mdx, syntax, tmlanguage, vs-code
- Language: JavaScript
- Homepage: https://wooorm.com/markdown-tm-language/
- Size: 2.25 MB
- Stars: 43
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# markdown-tm-language
[![Build][build-badge]][build]
Really good syntax highlighting for [markdown][] and [MDX][].
Example of markdown highlighting (using GitHub dark mode theme)
Example of MDX highlighting (using GitHub light mode theme)
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [`starry-night`](#starry-night)
* [`shiki`](#shiki)
* [VS Code](#vs-code)
* [Sublime and TextMate](#sublime-and-textmate)
* [Use](#use)
* [API](#api)
* [Syntax](#syntax)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This project includes high quality TextMate grammars for [markdown][] and
[MDX][].
[Try it out in the playground »][demo]
## When should I use this?
You can use these grammars in your code editor or with
[`starry-night`][starry-night] and [`shiki`][shiki].
## Install
### `starry-night`
These grammars are in [`github-linguist/linguist`][linguist],
which means that they are also in [`starry-night`][starry-night].
### `shiki`
These grammars are in [Shiki][].
### VS Code
For the MDX grammar,
use: [`vscode-mdx`][vscode-mdx].
### Sublime and TextMate
I’m not a Sublime or TextMate user and I am not very interested in maintaining
a packages for them currently.
You should be able to clone this repo somewhere
(`~/.config/sublime-text-2/Packages`?),
then you should reportedly be able to use these grammars.
PR welcome to improve this section or do the work to make it happen :)
## Use
After installing, type some things!
Or [use the playground][demo].
## API
There is no API.
You can generate your own grammars, by modifying `languages` in `build.js`.
To illustrate, you can add a new `language` there, or turn on or off several
extensions (such as `gfm`) in the existing ones.
## Syntax
Markdown is handled according to CommonMark and common extensions:
* directives
* frontmatter (YAML, TOML)
* GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
* GitHub (gemoji, mentions, references)
* math(†)
* MDX (ESM, expressions, JSX)
(†) — with two or more dollars.
## Compatibility
The markdown grammar supports CommonMark and common extensions: directives,
frontmatter, GFM, GitHub, and math.
The MDX grammar is similar, but of course uses the MDX syntax extensions, and
does not include directives.
## Security
Should be good!
## Related
* [`micromark`](https://github.com/micromark/micromark)
— markdown parser in JavaScript
* [`markdown-rs`](https://github.com/wooorm/markdown-rs)
— markdown parser in Rust
## Contribute
Yes please!
See [How to Contribute to Open Source][contribute].
In particular, see `grammar.yml`, that’s likely where your changes will go,
and it includes a ton of information on how it all works.
You might also want to check if the grammars here work with linguist.
Perform these steps:
```sh
git clone gh:github/linguist
cd linguist
./script/bootstrap
# copy/paste this repo in `linguist`
script/grammar-compiler add markdown-tm-language
```
## License
[MIT][license] © [Titus Wormer][author]
[author]: https://wooorm.com
[build-badge]: https://github.com/wooorm/markdown-tm-language/workflows/main/badge.svg
[build]: https://github.com/wooorm/markdown-tm-language/actions
[contribute]: https://opensource.guide/how-to-contribute/
[demo]: https://wooorm.com/markdown-tm-language/
[license]: license
[linguist]: https://github.com/github-linguist/linguist
[markdown]: https://commonmark.org
[mdx]: https://mdxjs.com
[shiki]: https://github.com/shikijs/shiki
[starry-night]: https://github.com/wooorm/starry-night
[vscode-mdx]: https://github.com/mdx-js/mdx-analyzer/tree/main/packages/vscode-mdx