{"id":15661271,"url":"https://github.com/jonschlinkert/markdown-symbols","last_synced_at":"2025-10-25T05:39:25.752Z","repository":{"id":14356919,"uuid":"17066617","full_name":"jonschlinkert/markdown-symbols","owner":"jonschlinkert","description":"Easily add and create custom symbols to use in markdown, and then compile them to HTML.","archived":false,"fork":false,"pushed_at":"2014-05-27T11:22:32.000Z","size":132,"stargazers_count":19,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-05T21:51:07.867Z","etag":null,"topics":["markdown"],"latest_commit_sha":null,"homepage":"https://github.com/jonschlinkert","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/jonschlinkert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-02-21T19:08:40.000Z","updated_at":"2023-04-14T02:03:47.000Z","dependencies_parsed_at":"2022-09-11T08:02:48.142Z","dependency_job_id":null,"html_url":"https://github.com/jonschlinkert/markdown-symbols","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jonschlinkert/markdown-symbols","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fmarkdown-symbols","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fmarkdown-symbols/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fmarkdown-symbols/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fmarkdown-symbols/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonschlinkert","download_url":"https://codeload.github.com/jonschlinkert/markdown-symbols/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fmarkdown-symbols/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264543865,"owners_count":23625386,"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":["markdown"],"created_at":"2024-10-03T13:26:46.073Z","updated_at":"2025-10-25T05:39:20.723Z","avatar_url":"https://github.com/jonschlinkert.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-symbols\n\n\u003e Easily add and create custom symbols to use in markdown, and then compile them to HTML.\n\nIf you find a bug or have a feature request, [please create an issue](https://github.com/jonschlinkert/markdown-symbols/issues).\n\nInspired by [@Vinz243](https://github.com/Vinz243) from [this issue on marked-extras](https://github.com/assemble/marked-extras/issues/3).\n\n## Install\nInstall with [npm](npmjs.org):\n\n```bash\nnpm i markdown-symbols --save\n``` \n\n## Usage\n```js\nvar symbols = require('markdown-symbols');\nsymbols.process( String );\n```\n\n## Add Custom Symbols\n\u003e An array of replacement patterns for custom symbols can be passed as a second parameter\n\n```js\nsymbols.process( String, patterns );\n```\n\nReplacement patterns follow this format:\n\n```js\nvar patterns = [\n  {\n    pattern: /foo/, // the pattern to replace\n    replacement: 'bar' // the replacement. can be a string or a function.\n  }\n];\n```\n\n### Example\n\nThis is the pattern and replacement used to for alerts:\n\n```js\nvar patterns = [\n  {\n    pattern: symbols.makeDelims(['!!', '!!']),\n    replacement: function (match, inner) {\n      var arr = inner.split('|');\n      var text = arr[0];\n      var modifier = arr[1] ? ' alert-' + arr[1] : '';\n      return '\u003cspan class=\"alert' + modifier + '\"\u003e' + text + '\u003c/span\u003e';\n    }\n  }\n];\n```\nTake a look at [index.js](./index.js) to see how the others are created.\n\n### .makeDelims()\n\nFor patterns, the `makeDelims` utility method is a convenience for more easily creating custom symbols:\n\n```js\nsymbols.makeDelims(['!!', '!!'])\n```\n\nThe [delims](https://github.com/jonschlinkert/delims) library is used to create delimiters, visit that project to learn about usage and available options.\n\n\n\n## Examples\nTo build the examples, run `npm i \u0026\u0026 node examples/example`\n\n### Labels\n\n```\n||This is a label!||\n||This is a label!|warning||\n||This is a label!|success||\n```\n\n### Spoiler\n\n```\n\u003e and captcha protected spoilers:\n\n\\{{Simple spoiler|info}}\n\n!\\{{Write me at \u003cjohn.doe@example.com\u003e|info}}\n```\n\n### Progress bars\n\n```\n=====0%=====\n=====10%|error=====\n=====40%|warning=====\n=====80%|success=====\n```\n\n### Glyphicons\n\n```\n::|search::\n```\n\n## Badges\n\n```\n[[42]]\n[[42|danger]]\n```\n\n## Jumbotrons\n\n```\n////\nHello, world|small\n////\n```\n\n## Alerts\n\n```\n!!New update released! !!\n!!New update released!|info!!\n```\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\nCopyright (c) 2014 Jon Schlinkert, contributors.  \nReleased under the MIT license","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Fmarkdown-symbols","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonschlinkert%2Fmarkdown-symbols","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Fmarkdown-symbols/lists"}