{"id":20475291,"url":"https://github.com/vim-utilities/markdown-surrounds","last_synced_at":"2026-04-20T07:31:37.289Z","repository":{"id":181324260,"uuid":"320710586","full_name":"vim-utilities/markdown-surrounds","owner":"vim-utilities","description":"Toggles MarkDown elements; bold, italic, and strike-through","archived":false,"fork":false,"pushed_at":"2023-11-06T17:29:26.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-09T22:20:49.335Z","etag":null,"topics":["markdown","vim-plugin"],"latest_commit_sha":null,"homepage":"","language":"Vim Script","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vim-utilities.png","metadata":{"files":{"readme":".github/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},"funding":{"liberapay":"vim-utilities"}},"created_at":"2020-12-11T23:55:59.000Z","updated_at":"2023-07-14T23:17:59.000Z","dependencies_parsed_at":"2023-11-07T01:14:29.218Z","dependency_job_id":"c9ca6ea5-acb2-4674-9d36-48022e5418a5","html_url":"https://github.com/vim-utilities/markdown-surrounds","commit_stats":null,"previous_names":["vim-utilities/markdown-surrounds"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vim-utilities/markdown-surrounds","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vim-utilities%2Fmarkdown-surrounds","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vim-utilities%2Fmarkdown-surrounds/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vim-utilities%2Fmarkdown-surrounds/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vim-utilities%2Fmarkdown-surrounds/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vim-utilities","download_url":"https://codeload.github.com/vim-utilities/markdown-surrounds/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vim-utilities%2Fmarkdown-surrounds/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32037846,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T00:18:06.643Z","status":"online","status_checked_at":"2026-04-20T02:00:06.527Z","response_time":94,"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","vim-plugin"],"created_at":"2024-11-15T15:15:37.355Z","updated_at":"2026-04-20T07:31:37.269Z","avatar_url":"https://github.com/vim-utilities.png","language":"Vim Script","funding_links":["https://liberapay.com/vim-utilities"],"categories":[],"sub_categories":[],"readme":"# Markdown Surrounds\n[heading__top]:\n  #markdown-surrounds\n  \"\u0026#x2B06; Toggles MarkDown elements; bold, italic, and strike-through\"\n\n\nToggles MarkDown elements; bold, italic, and strike-through\n\n\n## [![Byte size of Markdown Surrounds][badge__main__markdown_surrounds__source_code]][markdown_surrounds__main__source_code] [![Open Issues][badge__issues__markdown_surrounds]][issues__markdown_surrounds] [![Open Pull Requests][badge__pull_requests__markdown_surrounds]][pull_requests__markdown_surrounds] [![Latest commits][badge__commits__markdown_surrounds__main]][commits__markdown_surrounds__main]\n\n\n---\n\n\n- [:arrow_up: Top of Document][heading__top]\n\n- [:building_construction: Requirements][heading__requirements]\n\n- [:zap: Quick Start][heading__quick_start]\n\n  - [:floppy_disk: Clone][heading__clone]\n  - [:heavy_plus_sign: Install][heading__install]\n  - [:fire: Uninstall][heading__uninstall]\n  - [:arrow_up: Upgrade][heading__upgrade]\n  - [:bookmark_tabs: Documentation][heading__documentation]\n\n- [\u0026#x1F9F0; Usage][heading__usage]\n\n- [\u0026#x1F5D2; Notes][heading__notes]\n\n- [:chart_with_upwards_trend: Contributing][heading__contributing]\n\n  - [:trident: Forking][heading__forking]\n  - [:currency_exchange: Sponsor][heading__sponsor]\n\n- [:card_index: Attribution][heading__attribution]\n\n- [:balance_scale: Licensing][heading__license]\n\n\n---\n\n\n\n## Requirements\n[heading__requirements]:\n  #requirements\n  \"\u0026#x1F3D7; Prerequisites and/or dependencies that this project needs to function properly\"\n\n\nThis repository requires the [Vim][link__vim_home] text editor to be installed the source code is available on [GitHub -- `vim/vim`][link__vim_github], and most GNU Linux package managers are able to install Vim directly, eg...\n\n\n- Arch based Operating Systems\n\n\n```Bash\nsudo packman -Syy\n\nsudo packman -S gawk make vim\n```\n\n\n- Debian derived Distributions\n\n\n```Bash\nsudo apt-get update\n\nsudo apt-get install gawk make vim\n```\n\n\n\u003e Note `gawk` and `make` are only required if **not** utilizing a Vim plugin manager.\n\n\n______\n\n\n## Quick Start\n[heading__quick_start]:\n  #quick-start\n  \"\u0026#9889; Perhaps as easy as one, 2.0,...\"\n\n\n\u003e Perhaps as easy as one, 2.0,...\n\n\n---\n\n\n### Clone\n[heading__clone]:\n  #clone\n  \"\u0026#x1f4be;\"\n\n\nClone this project...\n\n\n```Bash\nmkdir -vp ~/git/hub/vim-utilities\n\ncd ~/git/hub/vim-utilities\n\ngit clone git@github.com:vim-utilities/markdown-surrounds.git\n```\n\n\n---\n\n\n### Install\n[heading__install]:\n  #install\n  \"\u0026#x2795;\"\n\n\nIf **not** using a plugin manager, then this plugin may be installed via `make install` command...\n\n\n```Bash\ncd ~/git/hub/vim-utilities/markdown-surrounds\n\nmake install\n```\n\n\n---\n\n\n### Uninstall\n[heading__uninstall]:\n  #uninstall\n  \"\u0026#x1f525;\"\n\n\nIf not using a plugin manager, then this plugin may be uninstalled via `uninstall` Make target...\n\n\n```Bash\ncd ~/git/hub/vim-utilities/markdown-surrounds\n\nmake uninstall\n```\n\n\n... Which will remove symbolic links and update the Vim help tags file.\n\n\n---\n\n\n### Upgrade\n[heading__upgrade]:\n  #upgrade\n  \"\u0026#x2b06;\"\n\n\nTo update in the future use `make upgrade` command...\n\n\n```Bash\ncd ~/git/hub/vim-utilities/markdown-surrounds\n\nmake upgrade\n```\n\n\n---\n\n\n### Documentation\n[heading__documentation]:\n  #documentation\n  \"\u0026#x1F4D1;\"\n\n\nAfter installation, plugin documentation may be accessed via Vim's `:help` command, eg...\n\n\n```Vim\n:help markdown-surrounds.txt\n```\n\n\n______\n\n\n### Usage\n[heading__usage]:\n  #usage\n  \"\u0026#x1F9F0; How to utilize this repository\"\n\n\nNormal mode default maps are provided for toggling bold, italic, and strike-through state; either for the current word, or line, that the cursor is on.\n\n\n- `\u003cLeader\u003e`\u003ckbd\u003eb\u003c/kbd\u003e toggle bold state of word under cursor.\n\n- `\u003cLeader\u003e`\u003ckbd\u003eB\u003c/kbd\u003e toggle bold state of line under cursor.\n\n- `\u003cLeader\u003e`\u003ckbd\u003ei\u003c/kbd\u003e toggle italic state of word under cursor.\n\n- `\u003cLeader\u003e`\u003ckbd\u003eI\u003c/kbd\u003e toggle italic state of line under cursor.\n\n- `\u003cLeader\u003e`\u003ckbd\u003ehi\u003c/kbd\u003e toggle highlight state of current word.\n\n- `\u003cLeader\u003e`\u003ckbd\u003eHI\u003c/kbd\u003e toggle highlight state current line.\n\n- `\u003cLeader\u003e`\u003ckbd\u003est\u003c/kbd\u003e toggle strike-through state of current word.\n\n- `\u003cLeader\u003e`\u003ckbd\u003eST\u003c/kbd\u003e toggle strike-through state current line.\n\n\n______\n\n\n## Notes\n[heading__notes]:\n  #notes\n  \"\u0026#x1F5D2; Additional things to keep in mind when developing\"\n\n\nThis repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.\n\n\n---\n\n\nCurrently when toggling state of words `\u003ccWORD\u003e` is used for obtaining the _big-word_ that the cursor is on. This means punctuation and non-letter symbols are included when toggling state. For example toggling bold state of an existing italic word...\n\n\n**Example italic word toggling results**\n\n\n```MarkDown\nSpam _flavored_ ham\n```\n\n\n**Example bolding italic word toggling results**\n\n\n```MarkDown\nSpam **_flavored_** ham\n```\n\n\n... this also means that currently to toggle italic state again requires first toggling bold state, ie. order of operations is outer-to-inner, eg...\n\n\n**Example out-of-order italic toggling results**\n\n\n```MarkDown\nSpam _**_flavored_**_ ham\n```\n\n\n... to obtain an un-formatted word from above example would then require the following sequence of commands...\n\n\n- `\u003cLeader\u003e`\u003ckbd\u003ei\u003c/kbd\u003e\n\n\n```MarkDown\nSpam **_flavored_** ham\n```\n\n\n- `\u003cLeader\u003e`\u003ckbd\u003eb\u003c/kbd\u003e\n\n\n```MarkDown\nSpam _flavored_ ham\n```\n\n- `\u003cLeader\u003e`\u003ckbd\u003ei\u003c/kbd\u003e\n\n\n```MarkDown\nSpam flavored ham\n```\n\n\n---\n\n\nWhen toggling current line state block-quote, un-ordered lists, and ordered lists are ignored, eg...\n\n\n**Example block-quoted line**\n\n\n```MarkDown\n\u003e Block quoted line\n```\n\n\n**Example strike-through block-quote**\n\n\n```MarkDown\n\u003e ~~Block quoted line~~\n```\n\n\n______\n\n\n## Contributing\n[heading__contributing]:\n  #contributing\n  \"\u0026#x1F4C8; Options for contributing to markdown-surrounds and vim-utilities\"\n\n\nOptions for contributing to markdown-surrounds and vim-utilities\n\n\n---\n\n\n### Forking\n[heading__forking]:\n  #forking\n  \"\u0026#x1F531; Tips for forking markdown-surrounds\"\n\n\nStart making a [Fork][markdown_surrounds__fork_it] of this repository to an account that you have write permissions for.\n\n\n- Add remote for fork URL. The URL syntax is _`git@github.com:\u003cNAME\u003e/\u003cREPO\u003e.git`_...\n\n\n```Bash\ncd ~/git/hub/vim-utilities/markdown-surrounds\n\ngit remote add fork git@github.com:\u003cNAME\u003e/markdown-surrounds.git\n```\n\n\n- Commit your changes and push to your fork, eg. to fix an issue...\n\n\n```Bash\ncd ~/git/hub/vim-utilities/markdown-surrounds\n\n\ngit commit -F- \u003c\u003c'EOF'\n:bug: Fixes #42 Issue\n\n\n**Edits**\n\n\n- `\u003cSCRIPT-NAME\u003e` script, fixes some bug reported in issue\nEOF\n\n\ngit push fork main\n```\n\n\n\u003e Note, the `-u` option may be used to set `fork` as the default remote, eg. _`git push -u fork main`_ however, this will also default the `fork` remote for pulling from too! Meaning that pulling updates from `origin` must be done explicitly, eg. _`git pull origin main`_\n\n\n- Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is _`https://github.com/\u003cNAME\u003e/\u003cREPO\u003e/pull/new/\u003cBRANCH\u003e`_\n\n\n\u003e Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the [dot-github](https://github.com/vim-utilities/.github) repository for detailed contributing guidelines.\n\n\n---\n\n\n### Sponsor\n  [heading__sponsor]:\n  #sponsor\n  \"\u0026#x1F4B1; Methods for financially supporting vim-utilities that maintains markdown-surrounds\"\n\n\nThanks for even considering it!\n\n\nVia Liberapay you may \u003csub\u003e[![sponsor__shields_io__liberapay]][sponsor__link__liberapay]\u003c/sub\u003e on a repeating basis.\n\n\nRegardless of if you're able to financially support projects such as markdown-surrounds that vim-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.\n\n\n______\n\n\n## Attribution\n[heading__attribution]:\n  #attribution\n  \"\u0026#x1F4C7; Resources that where helpful in building this project so far.\"\n\n\n- `:help :map-\u003cbuffer\u003e`\n\n- `:help curly-braces-function-names`\n\n- `:help fnamemodify()`\n\n- `:help readfile()`\n\n- `:help json_decode()`\n\n- `:help type()`\n\n- [GitHub -- `github-utilities/make-readme`](https://github.com/github-utilities/make-readme)\n\n- [StackExchange -- Vi -- How can I merge two dictionaries in Vim?](https://vi.stackexchange.com/questions/20842/)\n\n- [StackOverflow -- How do I disable the \"Press ENTER or type command to continue\" prompt in Vim?](https://stackoverflow.com/questions/890802/)\n\n- [StackOverflow -- Passing a dictionary to a function in viml](https://stackoverflow.com/questions/41433881/)\n\n\n______\n\n\n## License\n[heading__license]:\n  #license\n  \"\u0026#x2696; Legal side of Open Source\"\n\n\n```\nToggles MarkDown elements; bold, italic, and strike-through\nCopyright (C) 2020 S0AndS0\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU Affero General Public License as published\nby the Free Software Foundation, version 3 of the License.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU Affero General Public License for more details.\n\nYou should have received a copy of the GNU Affero General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n```\n\n\nFor further details review full length version of [AGPL-3.0][branch__current__license] License.\n\n\n\n[branch__current__license]:\n  /LICENSE\n  \"\u0026#x2696; Full length version of AGPL-3.0 License\"\n\n\n[badge__commits__markdown_surrounds__main]:\n  https://img.shields.io/github/last-commit/vim-utilities/markdown-surrounds/main.svg\n\n[commits__markdown_surrounds__main]:\n  https://github.com/vim-utilities/markdown-surrounds/commits/main\n  \"\u0026#x1F4DD; History of changes on this branch\"\n\n\n[markdown_surrounds__community]:\n  https://github.com/vim-utilities/markdown-surrounds/community\n  \"\u0026#x1F331; Dedicated to functioning code\"\n\n\n[issues__markdown_surrounds]:\n  https://github.com/vim-utilities/markdown-surrounds/issues\n  \"\u0026#x2622; Search for and _bump_ existing issues or open new issues for project maintainer to address.\"\n\n[markdown_surrounds__fork_it]:\n  https://github.com/vim-utilities/markdown-surrounds/\n  \"\u0026#x1F531; Fork it!\"\n\n[pull_requests__markdown_surrounds]:\n  https://github.com/vim-utilities/markdown-surrounds/pulls\n  \"\u0026#x1F3D7; Pull Request friendly, though please check the Community guidelines\"\n\n[markdown_surrounds__main__source_code]:\n  https://github.com/vim-utilities/markdown-surrounds/\n  \"\u0026#x2328; Project source!\"\n\n[badge__issues__markdown_surrounds]:\n  https://img.shields.io/github/issues/vim-utilities/markdown-surrounds.svg\n\n[badge__pull_requests__markdown_surrounds]:\n  https://img.shields.io/github/issues-pr/vim-utilities/markdown-surrounds.svg\n\n[badge__main__markdown_surrounds__source_code]:\n  https://img.shields.io/github/repo-size/vim-utilities/markdown-surrounds\n\n\n[link__vim_home]:\n  https://www.vim.org\n  \"Home page for the Vim text editor\"\n\n[link__vim_github]:\n  https://github.com/vim/vim\n  \"Source code for Vim on GitHub\"\n\n\n[sponsor__shields_io__liberapay]:\n  https://img.shields.io/static/v1?logo=liberapay\u0026label=Sponsor\u0026message=vim-utilities\n\n[sponsor__link__liberapay]:\n  https://liberapay.com/vim-utilities\n  \"\u0026#x1F4B1; Sponsor developments and projects that vim-utilities maintains via Liberapay\"\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvim-utilities%2Fmarkdown-surrounds","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvim-utilities%2Fmarkdown-surrounds","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvim-utilities%2Fmarkdown-surrounds/lists"}