{"id":20153913,"url":"https://github.com/jbroadway/slimdown","last_synced_at":"2025-04-13T23:34:24.137Z","repository":{"id":56765053,"uuid":"464273334","full_name":"jbroadway/slimdown","owner":"jbroadway","description":"A simple regex-based Markdown parser in PHP.","archived":false,"fork":false,"pushed_at":"2024-08-06T15:29:18.000Z","size":54,"stargazers_count":32,"open_issues_count":1,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T19:59:22.414Z","etag":null,"topics":["html","markdown","parser","parsing","php","regex","regexp"],"latest_commit_sha":null,"homepage":"","language":"PHP","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/jbroadway.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":"2022-02-27T22:52:13.000Z","updated_at":"2024-10-11T14:45:40.000Z","dependencies_parsed_at":"2022-08-16T02:10:41.190Z","dependency_job_id":"70f5094f-a4e4-40ca-a46b-c6f6f120cc5c","html_url":"https://github.com/jbroadway/slimdown","commit_stats":{"total_commits":13,"total_committers":2,"mean_commits":6.5,"dds":0.07692307692307687,"last_synced_commit":"232242694eab34a00d8702c760975ec7a5099cba"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbroadway%2Fslimdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbroadway%2Fslimdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbroadway%2Fslimdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbroadway%2Fslimdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jbroadway","download_url":"https://codeload.github.com/jbroadway/slimdown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248438469,"owners_count":21103410,"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":["html","markdown","parser","parsing","php","regex","regexp"],"created_at":"2024-11-13T23:23:36.967Z","updated_at":"2025-04-13T23:34:24.091Z","avatar_url":"https://github.com/jbroadway.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Slimdown\n\n![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/jbroadway/slimdown/ci.yml?branch=master)\n![GitHub License](https://img.shields.io/github/license/jbroadway/slimdown)\n![Packagist Version](https://img.shields.io/packagist/v/jbroadway/slimdown)\n![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/jbroadway/slimdown)\n\nA simple regex-based Markdown parser in PHP. Supports the\nfollowing elements (and can be extended via `Slimdown::add_rule()`):\n\n* Headers\n* Links\n* Bold\n* Emphasis\n* Deletions\n* Quotes\n* Code blocks\n* Inline code\n* Blockquotes\n* Ordered/unordered lists\n* Checklists\n* Images\n\nOriginally hosted as a [gist here](https://gist.github.com/jbroadway/2836900).\n\n## Usage\n\nHere is the general use case:\n\n```php\n\u003c?php\n\nrequire_once ('Slimdown.php');\n\necho Slimdown::render (\n\t\"# Page title\\n\\nAnd **now** for something _completely_ different.\"\n);\n```\n\nOr via [composer](https://getcomposer.org/):\n\n```\ncomposer require jbroadway/slimdown\n```\n\nThen:\n\n```php\n\u003c?php\n\nrequire __DIR__ . '/vendor/autoload.php';\n\necho Slimdown::render (\n\t\"# Page title\\n\\nAnd **now** for something _completely_ different.\"\n);\n```\n\n### Adding rules\n\nA simple rule to convert `:)` to an image:\n\n```php\n\u003c?php\n\nSlimdown::add_rule ('/(\\W)\\:\\)(\\W)/', '\\1\u003cimg src=\"smiley.png\" /\u003e\\2');\n\necho Slimdown::render ('Know what I\\'m sayin? :)');\n```\n\nIn this example, we add GitHub-style internal linking\n(e.g., `[[Another Page]]`).\n\n```php\n\u003c?php\n\nfunction mywiki_internal_link ($title) {\n\treturn sprintf (\n\t\t'\u003ca href=\"%s\"\u003e%s\u003c/a\u003e',\n\t\tpreg_replace ('/[^a-zA-Z0-9_-]+/', '-', $title),\n\t\t$title\n\t);\n}\n\nSlimdown::add_rule ('/\\[\\[(.*?)\\]\\]/e', 'mywiki_internal_link (\\'\\\\1\\')');\n\necho Slimdown::render ('Check [[This Page]] out!');\n```\n\n### A longer example\n\n```php\n\u003c?php\n\necho Slimdown::render (\"# Title\n\nAnd *now* [a link](http://www.google.com) to **follow** and [another](http://yahoo.com/).\n\n* One\n* Two\n* Three\n\n## Subhead\n\nOne **two** three **four** five.\n\nOne __two__ three _four_ five __six__ seven _eight_.\n\n1. One\n2. Two\n3. Three\n\nMore text with `inline($code)` sample.\n\n\u003e A block quote\n\u003e across two lines.\n\n- [ ] One\n- [x] Two\n- [ ] Three\n\nMore text...\");\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbroadway%2Fslimdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjbroadway%2Fslimdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbroadway%2Fslimdown/lists"}