{"id":13825579,"url":"https://github.com/rhysd/vim-gfm-syntax","last_synced_at":"2025-09-07T07:02:57.936Z","repository":{"id":46606055,"uuid":"67557939","full_name":"rhysd/vim-gfm-syntax","owner":"rhysd","description":"GitHub Flavored Markdown syntax highlight extension for Vim","archived":false,"fork":false,"pushed_at":"2023-05-16T12:41:48.000Z","size":71,"stargazers_count":115,"open_issues_count":4,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-09-07T07:02:35.316Z","etag":null,"topics":["markdown","plugin","vim"],"latest_commit_sha":null,"homepage":null,"language":"Vim script","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/rhysd.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":"2016-09-07T00:43:19.000Z","updated_at":"2025-04-28T11:59:25.000Z","dependencies_parsed_at":"2024-08-04T09:04:01.406Z","dependency_job_id":"eb45daaa-28aa-4107-b4fc-fd25671517a3","html_url":"https://github.com/rhysd/vim-gfm-syntax","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rhysd/vim-gfm-syntax","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fvim-gfm-syntax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fvim-gfm-syntax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fvim-gfm-syntax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fvim-gfm-syntax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rhysd","download_url":"https://codeload.github.com/rhysd/vim-gfm-syntax/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rhysd%2Fvim-gfm-syntax/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274005320,"owners_count":25205935,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["markdown","plugin","vim"],"created_at":"2024-08-04T09:01:23.669Z","updated_at":"2025-09-07T07:02:57.888Z","avatar_url":"https://github.com/rhysd.png","language":"Vim script","funding_links":[],"categories":["Vim Script"],"sub_categories":[],"readme":"GitHub Flavored Markdown Syntax Extension for Vim\n=================================================\n[![Build Status](https://travis-ci.org/rhysd/vim-gfm-syntax.svg?branch=master)](https://travis-ci.org/rhysd/vim-gfm-syntax)\n\nThis Vim plugin provides extra syntax highlight for [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/). GitHub adds their extra features to Markdown.  This plugin fills the gap between normal Markdown and GitHub Flavored Markdown.\n\nSupports for below syntax are added:\n\n| Name         | Example |\n|:------------:|:-------:|\n| Inline code  | `code`  |\n| Mentions     | @rhysd  |\n| Issue number | #123    |\n| Emoji        | :dog:   |\n| Check box    | `- [x]` |\n| Table        | This!   |\n\nAnd it also supports concealing emoji characters.\n\n\n## Screenshot\n\n| Before | After |\n|--------|-------|\n|![before][]|![after][]|\n\n\n## Usage\n\nBy default, this plugin is enabled for all `markdown` filetype files.\n\nIf you want to enable these extra syntax highlights in specific file, you can use `g:gfm_syntax_enable_filetypes` and sub filetypes.\n\nExample: Only README.md enables extra highlight.\n\n```vim\nlet g:gfm_syntax_enable_always = 0\nlet g:gfm_syntax_enable_filetypes = ['markdown.gfm']\nautocmd BufRead,BufNew,BufNewFile README.md setlocal ft=markdown.gfm\n```\n\nIf you want to highlight inner code block, standard syntax highlight support for Markdown already supports it.\n\n```vim\nlet g:markdown_fenced_languages = ['cpp', 'ruby', 'json']\n```\n\nIn above Example, C++, Ruby and JSON code blocks will be highlighted with their syntax highlight.  Please note that enabling so many filetypes for code block may cause performance issue on highlighting.\n\nIf you want to support specific feature of GFM, you can control them to be highlighted by some variables.\n\n| Variable                               | Description                                 |\n|----------------------------------------|---------------------------------------------|\n| `g:gfm_syntax_highlight_inline_code`   | If `0`, inline codes won't be highlighted.  |\n| `g:gfm_syntax_highlight_mention`       | If `0`, mentions won't be highlighted.      |\n| `g:gfm_syntax_highlight_strikethrough` | If `0`, strikethrough won't be highlighted. |\n| `g:gfm_syntax_highlight_emoji`         | If `0`, emojis won't be highlighted.        |\n| `g:gfm_syntax_highlight_table`         | If `0`, tables won't be highlighted.        |\n| `g:gfm_syntax_highlight_issue_number`  | If `0`, issue number won't be highlighted   |\n| `g:gfm_syntax_highlight_checkbox`      | If `0`, check box won't be highlighted      |\n\nIf you want to use your favorite colors for syntax highlights, you can override highlight definitions.  Below configration is an example where inline code will be highlighted with `CursorLine` highlight.\n\n```vim\nautocmd ColorScheme * highlight link githubFlavoredMarkdownCode CursorLine\n```\n\n`githubFlavoredMarkdownCode` is a highlight rule for inline code.  For other rules, please see [after/syntax/markdown/gfm.vim](after/syntax/markdown/gfm.vim).  There are so many colorschemes for Vim.  One syntax file can't consider all of them.  If you feel some highlighting is not good, please customize by yourself.\n\nNote: Standard markdown syntax highlight offers `markdownCode` to highlight `inline codes`, but they also highlight code blocks.  `githubFlavoredMarkdownCode` only highlights inline codes.\n\n## Emoji Concealing\n\n![screenshot](https://github.com/rhysd/ss/blob/master/vim-gfm-syntax/emoji-conceal.gif?raw=true)\n\nThis plugin also supports concealing emojis using Vim's 'conceal' feature. When `g:gfm_syntax_emoji_conceal` is set to `1`, emojis such as `:dog:` in will be displayed as real emoji like :dog:. Original text (`:dog:`) remains as is. Concealing happens only in non-current lines.\n\n## What is the Difference from [vim-flavored-markdown](https://github.com/jtratner/vim-flavored-markdown)?\n\n[vim-flavored-markdown](https://github.com/jtratner/vim-flavored-markdown) was created for the same purpose as this plugin, and it works well.\nBut it does not match to my usecase in terms of below points.\n\n- vim-flavored-markdown introduces new filetype `ghmarkdown`.\n  This is useful if you want to distinguish Markdown and GFM.\n  Otherwise, it kills original `markdown` filetype.\n  It means that many other plugins for `markdown` filetype are killed as well.\n- Because vim-flavored-markdown is a fork of old version of [vim-markdown](https://github.com/tpope/vim-markdown), it lacks some improvements (e.g. code block highlight).\n- vim-gfm-syntax supports more GFM syntax (e.g. checkbox), well-tested (with [themis.vim](https://github.com/thinca/vim-themis)), customizable (you can choose which syntax should be highlighted).\n\n\n## License\n\nThis plugin is distributed under [the MIT License](LICENSE).\n\n[before]: https://raw.githubusercontent.com/rhysd/ss/master/vim-gfm-syntax/before.png\n[after]: https://raw.githubusercontent.com/rhysd/ss/master/vim-gfm-syntax/after.png\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhysd%2Fvim-gfm-syntax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frhysd%2Fvim-gfm-syntax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frhysd%2Fvim-gfm-syntax/lists"}