{"id":15026586,"url":"https://github.com/edditoria/markdown-plus-plus","last_synced_at":"2025-12-17T04:09:11.498Z","repository":{"id":5230231,"uuid":"6406835","full_name":"Edditoria/markdown-plus-plus","owner":"Edditoria","description":"Markdown syntax highlighting for Notepad++, by customized UDL file (user defined language)","archived":false,"fork":false,"pushed_at":"2022-08-23T20:16:40.000Z","size":2258,"stargazers_count":1520,"open_issues_count":19,"forks_count":277,"subscribers_count":68,"default_branch":"master","last_synced_at":"2025-05-15T10:06:50.389Z","etag":null,"topics":["hacktoberfest","markdown","notepad-plus-plus","notepadplusplus","syntax-highlighting","udl"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"labodj/Hammerhead-Linaro","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Edditoria.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-10-26T16:24:10.000Z","updated_at":"2025-05-09T14:44:38.000Z","dependencies_parsed_at":"2022-08-06T18:01:12.853Z","dependency_job_id":null,"html_url":"https://github.com/Edditoria/markdown-plus-plus","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edditoria%2Fmarkdown-plus-plus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edditoria%2Fmarkdown-plus-plus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edditoria%2Fmarkdown-plus-plus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Edditoria%2Fmarkdown-plus-plus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Edditoria","download_url":"https://codeload.github.com/Edditoria/markdown-plus-plus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319721,"owners_count":22051074,"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":["hacktoberfest","markdown","notepad-plus-plus","notepadplusplus","syntax-highlighting","udl"],"created_at":"2024-09-24T20:04:44.397Z","updated_at":"2025-12-17T04:09:11.380Z","avatar_url":"https://github.com/Edditoria.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Syntax Highlighting for Notepad++\n\nThis repo \"markdown-plus-plus\" is a project to support Markdown syntax highlighting in [Notepad++][npp_site]. It is done via various **User Defined Language (UDL) XML files**. All UDLs are carefully designed by human, rather than generated by machine.\n\nYou can simply consume the UDL XML file that matches your favorite theme, or config your own using the build system.\n\nThanks for encouragements and comments. This repo is not only for myself anymore. It's for everyone.\n\nLove Notepad++? Need to write docs in Markdown? This repo is made for you.\n\n## Screenshots\n\n| Your | Taste! |\n|:----:|:------:|\n| ![Markdown in Default Theme of Notepad++][screen_default] | ![Markdown in Zenburn Theme of Notepad++][screen_zenburn] |\n| Default | Zenburn |\n| ![Markdown in Bespin Theme of Notepad++][screen_bespin] | ![Markdown in Blackboard Theme of Notepad++][screen_blackboard] |\n| Bespin | Blackboard |\n| ![Markdown in Deep Black Theme of Notepad++][screen_deep_black] | ![Markdown in Obsidian Theme of Notepad++][screen_obsidian] |\n| Deep Black | Obsidian |\n| ![Markdown in Solarized Theme of Notepad++][screen_solarized] | ![Markdown in Solarized-light Theme in Notepad++][screen_solarized_light] |\n| Solarized | Solarized-light |\n| ![Markdown in Twilight Theme of Notepad++][screen_twilight] | ![Markdown in Material Theme in Notepad++][screen_material] |\n| Twilight | Material |\n\nSupports file extensions: `.markdown` and `.md`\u003cbr\u003e\nTested: Notepad++ v8.4.4 64-bit on Windows 10\n\n## Usage\n\n### Node.js\n\nIf you had installed Node.js in your system, you can use `npx` command to get UDL file(s):\n\n```cmd\n:: Check whether you have Node.js installed\nnode -v\n\n:: Go to UDL folder of Notepad++. Usually...\ncd %AppData%\\Notepad++\\userDefineLangs\n\n:: Example: Download Solarized-light UDL file\nnpx markdown-plus-plus solarized-light\n\n:: Example: Download Solarized UDL file for Dark Mode\nnpx markdown-plus-plus solarized --dark\n\n:: Read help for details\nnpx markdown-plus-plus --help\n```\n\nYou can choose to install this package in your system:\n\n```cmd\n:: Enable `mpp` command instead of `npx markdown-plus-plus`...\nnpm install --global markdown-plus-plus\n\n:: List all themes\nmpp --list\n\n:: Example: Download Solarized-light UDL file\nmpp solarized-light\n\n:: Example: Download Solarized UDL file for Dark Mode\nmpp solarized --dark\n\n:: Update this package\nnpm update markdown-plus-plus\n```\n\n### Download Manually\n\n1. Download the source code in [latest release page][latest_release]. It should be a zip file.\n1. Open the zip file and go to `\u003cudl\\\u003e` folder.\n1. Copy a XML file of your favorite theme, and paste in `\u003cuserDefineLangs\\\u003e` folder of Notepad++. The directory is *usually* `\u003c%AppData%\\Notepad++\\userDefineLangs\\\u003e`.\n1. Restart Notepad++.\n1. Open and test with a Markdown file e.g. [test/at-a-glance.md](test/at-a-glance.md).\n\n**Enjoy!!**\n\n## Dark Mode\n\nNotepad++ features Dark Mode with great UDL enhancements since v8.1.3. In short, you may want 2 files:\n\n```cmd\n:: Make sure you are running mpp v3.4+\nmpp --version\n\n:: Go to UDL folder of Notepad++. Usually...\ncd %AppData%\\Notepad++\\userDefineLangs\n\n:: Download Solarized UDL file\nmpp solarized\n\n:: Download Solarized UDL file for Dark Mode,\n:: even though you use the same theme\nmpp solarized --dark\n```\n\nNPP will pick up the correct file for dark mode. Here're some conventions in this package:\n\n|          | Normal | Dark Mode |\n| -------- | ------ | --------- |\n| Command  | `mpp \u003ctheme-name\u003e` | `mpp \u003ctheme-name\u003e --dark` |\n| Filename | `\u003cmarkdown.theme-name.udl.xml\u003e` | `\u003cmarkdown.theme-name.dark.udl.xml\u003e` |\n| UDL name | Theme Name (markdown) | Theme Name \\[markdown\\] |\n\n## Limitations\n\nNeed your input to solve the following problems:\n\n- `_em text_`, `__strong text__` and `___em strong text___` only parse the first word because it will screw up some URLs such as `example__url`.\n- Cannot use asterisk-style bullet points (`* a \\\u003cli\\\u003e bullet point`). Instead, please write in `- a bullet point` or `+ a bullet point`.\n- Improve documentations. My English sucks. (\\*´ｰ\\`\\*)\n- The GFM's strikethrough `~~like this~~` is still missing. Will do it later.\n\nIf Notepad++ doesn't redraw your current markdown file(s), please re-open the NPP application and/or re-open the markdown file. Upgrade NPP may help.\n\n## Build Your Own UDL Files\n\nThe best way to build your own UDL file is to fork this repo. You need to install Node.js in your system.\n\n```cmd\n:: In your dev folder\ngit clone https://github.com/Edditoria/markdown-plus-plus.git\ncd markdown-plus-plus\nnpm install\n\n:: Play around. Finally, run the build script\nnpm run build\n```\n\nFor details, please read the document: [build-workflow.md](docs/build-workflow.md)\n\n## Options\n\nOptions are reviewed in v3. In **each** config file in the config folder, you can adjust for your own build. Here are some examples:\n\n| Option | Descriptions |\n| ------ | ------------ |\n| `goodies.highlightHex` | Highlight HEX value. |\n| `flags.transparentBg` | Make the text background being transparent. :warning: **Use it with caution** |\n| `flags.asteriskUnorderedList` | Enable the markdown style of asterisk-style bullet points (`* a \\\u003cli\\\u003e bullet point`). :warning: **Use it with caution** |\n\nFor details, please read the document: [build-workflow.md](docs/build-workflow.md)\n\n## Key Changes from v2 to v3\n\n- Markdown-plus-plus is a npm package now. You can fetch the UDL files in command line directly, `npx markdown-plus-plus --help`.\n- Build system relies on Node.js. `git clone` then `npm install` to develop this repo. Less dependency hell.\n- In v2, there are 2 builds for every theme: Modern and classic. Now, there are only 1 build. The main difference in classic build, [asterisk-style bullet points][end_of_v2], becomes an option in v3.\n- Better file structure:\n\t- You can find all UDL files in one single folder called `\u003cudl\\\u003e`.\n\t- You can modify the config files in another folder called `\u003cconfig\\\u003e`.\n\t- Filename for UDLs follows the pattern: `\u003cmarkdown.[theme-name].udl.xml\u003e`.\n\t- Filename for configs follows this pattern: `\u003cmarkdown.[theme-name].config.json\u003e`\n\n## Contribution\n\n*tl;tr* For pull request, please merge from **your new branch** into **my master branch** (recommend **enabling \"Allow edits from maintainers\"**); Or, propose a file change in Github directly; Or, hit me a message via issue page or my social contacts.\n\nFor details, please kindly read [CONTRIBUTING.md](https://github.com/Edditoria/.github/blob/main/CONTRIBUTING.md).\n\n:beer: Thank you so much! :pray:\n\n## Copyright and License\n\nCopyright for portions of [this repository][this_repo] are held by Thomas Smits since 2010 as part of [his repository][thomsmits_repo]. All other copyright are held by Edditoria since 2012.\n\nCode released under the [MIT License](LICENSE.txt). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/4.0/).\n\nAs human-readable summary (but not a substitute for the license):\n\nYou can use it, share it, modify the code and distribute your work for private and commercial uses. If you like, please share your work with me. :pizza:\n\n\n[screen_default]: docs/images/themes/default-screenshot.png \"Markdown in Default Theme of Notepad++\"\n[screen_zenburn]: docs/images/themes/zenburn-screenshot.png \"Markdown in Zenburn Theme of Notepad++\"\n[screen_bespin]: docs/images/themes/bespin-screenshot.png \"Markdown in Bespin Theme of Notepad++\"\n[screen_blackboard]: docs/images/themes/blackboard-screenshot.png \"Markdown in Blackboard Theme of Notepad++\"\n[screen_deep_black]: docs/images/themes/deep-black-screenshot.png \"Markdown in Deep Black Theme of Notepad++\"\n[screen_obsidian]: docs/images/themes/obsidian-screenshot.png \"Markdown in Obsidian Theme of Notepad++\"\n[screen_solarized]: docs/images/themes/solarized-screenshot.png \"Markdown in Solarized Theme of Notepad++\"\n[screen_solarized_light]: docs/images/themes/solarized-light-screenshot.png \"Markdown in Solarized-light Theme of Notepad++\"\n[screen_twilight]: docs/images/themes/twilight-screenshot.png \"Markdown in Twilight Theme of Notepad++\"\n[screen_material]: docs/images/themes/material-screenshot.png \"Markdown in Material Theme of Notepad++\"\n\n[npp_site]: https://notepad-plus-plus.org\n[end_of_v2]: https://github.com/Edditoria/markdown-plus-plus/tree/checkpoint/end-of-v2#step-zero-pick-your-side\n[latest_release]: https://github.com/Edditoria/markdown-plus-plus/releases/latest\n[this_repo]: https://github.com/Edditoria/markdown-plus-plus\n[thomsmits_repo]: https://github.com/thomsmits/markdown_npp\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedditoria%2Fmarkdown-plus-plus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedditoria%2Fmarkdown-plus-plus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedditoria%2Fmarkdown-plus-plus/lists"}