{"id":20791704,"url":"https://github.com/mailchimp/mc_markdown","last_synced_at":"2025-08-19T11:09:25.496Z","repository":{"id":8040161,"uuid":"9450350","full_name":"mailchimp/mc_markdown","owner":"mailchimp","description":"gem for mailchimp flavoured markdown","archived":false,"fork":false,"pushed_at":"2014-12-15T21:43:06.000Z","size":590,"stargazers_count":7,"open_issues_count":1,"forks_count":2,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-07-28T03:10:33.324Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mailchimp.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-15T14:17:38.000Z","updated_at":"2018-12-14T19:33:37.000Z","dependencies_parsed_at":"2022-09-13T17:51:19.240Z","dependency_job_id":null,"html_url":"https://github.com/mailchimp/mc_markdown","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/mailchimp/mc_markdown","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmc_markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmc_markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmc_markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmc_markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mailchimp","download_url":"https://codeload.github.com/mailchimp/mc_markdown/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmc_markdown/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271143398,"owners_count":24706346,"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-08-19T02:00:09.176Z","response_time":63,"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":[],"created_at":"2024-11-17T15:46:53.668Z","updated_at":"2025-08-19T11:09:25.434Z","avatar_url":"https://github.com/mailchimp.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Our chimpy flavour of [Redcarpet](https://github.com/vmg/redcarpet) Markdown with a few escaping tricks for merge tags and content writer friendly extensions.\n\n# Use\n\n### Installation\n\nIn your Gemfile:\n\n```ruby\ngem \"mc_markdown\", git: 'git@github.com:mailchimp/mc_markdown.git'\n```\n\nThen `bundle install`\n\n\n### Quick Examples\n\nRendering with the Base renderer\n\n```ruby\nMCMarkdown.render \"# Hello World\"\n# =\u003e '\u003ch1\u003eHello World\u003c/h1\u003e'\n\nMCMarkdown.render \"*|MERGE_TASTIC|*\"\n# =\u003e '\u003cp\u003e*|MERGE_TASTIC|*\u003c/p\u003e'\n\nMCMarkdown.render \"[Sign Up {btn}](/signup)\"\n# =\u003e '\u003ca href=\"/signup\" class=\"btn\"\u003eSign Up\u003c/a\u003e'\n```\n\n\nGetting a renderer to use\n\n```ruby\nhtml = MCMarkdown::Renderers.use :html\n# =\u003e MCMarkdown::HTML initialized for Redcarpet::Markdown\n\nhtml.render '# Hello World'\n# =\u003e '\u003ch1\u003eHello World\u003c/h1\u003e'\n```\n\n\nCan also extract frontmatter\n\n```ruby\nfrontmatter, html = MCMarkdown.render_with_frontmatter \"---\\nfoo:bar\\n---\\n\\n# Hello World\"\n# =\u003e { \"foo\" =\u003e \"bar\" }, \"\u003ch1\u003eHello World\\n\"\n```\n\n\n### Full Docs\n\n**[Renderers](doc/renderers.md)**  \nOur \"top level\" objects, they coordinate collections of formatters and take the `#render` method to render our input markdown.\n\n**[Formatters](doc/formatters.md)**  \nFormatters are the individual parts that differ from the base [Redcarpet](https://github.com/vmg/redcarpet) implementation. Some implement something like \"shortag\" codes in markdown.\n\n\n# Testing\n\n```bash\n$ rspec\n# =\u003e runs the test suite\n```\n\n\n# Contributing\n\nIf there is any thing you'd like to contribute or fix, please:\n\n- Fork the repo\n- Add tests for any new functionality\n- Make your changes\n- Verify all existing tests work properly\n- Make a pull request\n\n\n# License\n\nThe `mc_markdown` gem is distributed under the [BSD 3.0 license](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailchimp%2Fmc_markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmailchimp%2Fmc_markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailchimp%2Fmc_markdown/lists"}