{"id":13906576,"url":"https://github.com/jonschlinkert/pretty-remarkable","last_synced_at":"2025-10-23T07:30:52.589Z","repository":{"id":31085365,"uuid":"34644391","full_name":"jonschlinkert/pretty-remarkable","owner":"jonschlinkert","description":"Plugin for prettifying markdown with https://github.com/jonschlinkert/remarkable using custom renderer rules.","archived":false,"fork":false,"pushed_at":"2018-07-05T19:45:55.000Z","size":66,"stargazers_count":23,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-13T10:17:24.291Z","etag":null,"topics":["beautify","format","formatter","gfm","markdown","plugin","prettify","remarkable"],"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","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-27T03:42:33.000Z","updated_at":"2022-11-23T02:13:35.000Z","dependencies_parsed_at":"2022-09-09T08:12:23.826Z","dependency_job_id":null,"html_url":"https://github.com/jonschlinkert/pretty-remarkable","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fpretty-remarkable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fpretty-remarkable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fpretty-remarkable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonschlinkert%2Fpretty-remarkable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonschlinkert","download_url":"https://codeload.github.com/jonschlinkert/pretty-remarkable/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237793950,"owners_count":19367422,"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":["beautify","format","formatter","gfm","markdown","plugin","prettify","remarkable"],"created_at":"2024-08-06T23:01:38.533Z","updated_at":"2025-10-23T07:30:47.248Z","avatar_url":"https://github.com/jonschlinkert.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# pretty-remarkable [![NPM version](https://img.shields.io/npm/v/pretty-remarkable.svg?style=flat)](https://www.npmjs.com/package/pretty-remarkable) [![NPM monthly downloads](https://img.shields.io/npm/dm/pretty-remarkable.svg?style=flat)](https://npmjs.org/package/pretty-remarkable) [![NPM total downloads](https://img.shields.io/npm/dt/pretty-remarkable.svg?style=flat)](https://npmjs.org/package/pretty-remarkable) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/pretty-remarkable.svg?style=flat\u0026label=Travis)](https://travis-ci.org/jonschlinkert/pretty-remarkable)\n\n\u003e Plugin for prettifying markdown with Remarkable using custom renderer rules.\n\nPlease consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.\n\n- [Install](#install)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Formatting](#formatting)\n  * [Tables](#tables)\n  * [Unordered lists](#unordered-lists)\n  * [Ordered lists](#ordered-lists)\n- [About](#about)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save pretty-remarkable\n```\n\n## Usage\n\n```js\nvar prettify = require('pretty-remarkable');\n```\n\n## Examples\n\n```js\nvar prettify = require('pretty-remarkable');\nvar Remarkable = require('remarkable');\nvar md = new Remarkable();\n\n// register the plugin\nmd.use(prettify);\nvar result = md.render('\\n\\n\\n# foo\\n\\n\\nbar\\n# baz');\n//=\u003e '# foo\\n\\nbar\\n\\n# baz'\n```\n\nOr create a function if you need to export it or need a more reusable format:\n\n```js\nvar prettify = require('pretty-remarkable');\nvar Remarkable = require('remarkable');\n\nfunction pretty(str, options) {\n  return new Remarkable()\n    .use(prettify)\n    .render(str);\n}\n\npretty('\\n\\n\\n# foo\\n\\n\\nbar\\n# baz');\n//=\u003e '# foo\\n\\nbar\\n\\n# baz'\n```\n\n## Formatting\n\nIn addition to the formatting mentioned in the following sections:\n\n* does not modify `code` or gfm code blocks\n* ensures that an extra newline precedes gfm code blocks, since some text editors do not display proper hightlighting otherwise\n* unless `options.condense` is false, condenses 3+ newlines down to two\n\n### Tables\n\nNormalizes table formatting.\n\n**Example**\n\n```markdown\nBefore\n**A**|**B**|**C**\n|---:|:---|---|\na |b |c\nx |y |z\nAfter\n```\n\nIs normalized to:\n\n```markdown\nBefore\n\n| **A** | **B** | **C** | \n| ---: | :--- | --- |\n| a | b | c |\n| x | y | z |\n\nAfter\n```\n\n### Unordered lists\n\nNormalizes unordered lists.\n\n**Example**\n\n```markdown\n* a\n* b\n  * c\n  * d\n    * e\n    * f\n```\n\nIs normalized to:\n\n```markdown\n* a\n* b\n  - c\n  - d\n    + e\n    + f\n```\n\n### Ordered lists\n\nNormalizes ordered lists.\n\n**Example**\n\n```markdown\n1. foo\n  a. aaa\n  b. bbb\n  c. ccc\n1. bar\n1. baz\n\n```\n\nIs normalized to:\n\n```markdown\n1. foo\n  a. aaa\n  b. bbb\n  c. ccc\n2. bar\n3. baz\n\n```\n\n## About\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eContributing\u003c/strong\u003e\u003c/summary\u003e\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eRunning Tests\u003c/strong\u003e\u003c/summary\u003e\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eBuilding docs\u003c/strong\u003e\u003c/summary\u003e\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme \u0026\u0026 verb\n```\n\n\u003c/details\u003e\n\n### Related projects\n\nYou might also be interested in these projects:\n\n* [markdown-toc](https://www.npmjs.com/package/markdown-toc): Generate a markdown TOC (table of contents) with Remarkable. | [homepage](https://github.com/jonschlinkert/markdown-toc \"Generate a markdown TOC (table of contents) with Remarkable.\")\n* [markdown-utils](https://www.npmjs.com/package/markdown-utils): Tiny helpers for creating consistenly-formatted markdown snippets. | [homepage](https://github.com/jonschlinkert/markdown-utils \"Tiny helpers for creating consistenly-formatted markdown snippets.\")\n* [prettify-markdown](https://www.npmjs.com/package/prettify-markdown): Prettify, format or beautify your markdown. Whatever you want to call it, this does that… [more](https://github.com/jonschlinkert/prettify-markdown) | [homepage](https://github.com/jonschlinkert/prettify-markdown \"Prettify, format or beautify your markdown. Whatever you want to call it, this does that. Used on hundreds of projects by verb.\")\n* [remarkable](https://www.npmjs.com/package/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in… [more](https://github.com/jonschlinkert/remarkable) | [homepage](https://github.com/jonschlinkert/remarkable \"Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.\")\n\n### Author\n\n**Jon Schlinkert**\n\n* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)\n* [GitHub Profile](https://github.com/jonschlinkert)\n* [Twitter Profile](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on July 05, 2018._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Fpretty-remarkable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonschlinkert%2Fpretty-remarkable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonschlinkert%2Fpretty-remarkable/lists"}