{"_id":"@nomadreservations/angular2-markdown","_rev":"33-0882c2f7d8315f3026a43530212b8568","name":"@nomadreservations/angular2-markdown","description":"[![Build Status][travis-badge]][travis-badge-url] [![npm][circleci-badge-url]][circleci-url] [![version][npm-badge-url]][npm-url] [![npm][license-badge-url]][license-url] [![npm][dep-badge-url]][dep-url]","dist-tags":{"latest":"2.2.0"},"versions":{"2.2.0":{"main":"bundles/angular2-markdown.umd.js","version":"2.2.0","module":"index.js","typings":"index.d.ts","keywords":["ng","angular","angular2","angular4","angular5","ngx","markdown","prismjs"],"author":{"name":"Dimpu Aravind Buddha","email":"buddhaaravind@gmail.com"},"license":"MIT","repository":{"type":"git","url":"git+ssh://git@github.com/dimpu/angular2-markdown.git"},"name":"@nomadreservations/angular2-markdown","dependencies":{"marked":"^0.3.6","prismjs":"^1.8.4"},"peerDependencies":{"rxjs":"^5.5.2","@angular/core":"^2.4.0 || ^4.0.3 || ^5.0.0"},"_id":"@nomadreservations/angular2-markdown@2.2.0","devDependencies":{},"description":"[![Build Status][travis-badge]][travis-badge-url] [![npm][circleci-badge-url]][circleci-url] [![version][npm-badge-url]][npm-url] [![npm][license-badge-url]][license-url] [![npm][dep-badge-url]][dep-url]","bugs":{"url":"https://github.com/dimpu/angular2-markdown/issues"},"homepage":"https://github.com/dimpu/angular2-markdown#readme","_npmVersion":"5.5.1","_nodeVersion":"8.9.1","_npmUser":{"name":"paulryan","email":"paul@campgroundbooking.com"},"dist":{"integrity":"sha512-g4Su5OA9TJUFBoFlIvam+WecsrDYyEtschdo86QRFUGogiAW931oESPj47YDz+iwuPBnKesx3NgpAvy/byAuRA==","shasum":"4866bfdb8605360f942f46ce22a968beeb648138","tarball":"https://registry.npmjs.org/@nomadreservations/angular2-markdown/-/angular2-markdown-2.2.0.tgz","npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2Tk7CRA9TVsSAnZWagAAhGIP/2hZcN2tRnYW6J7YCP0A\nMALhI/JmLIrGa4YDh+eOP11D7BK3nCtUwq/Wy4LYF2GC0XiCCcKwX7rTBvSd\nXL+8/d5O4N2o9bGlkRt+Nss4/PeUoVBiB0M63ISatBG7U6uOTSids5tRF0F5\nolumtP/KYaUGDGrzukrkXseaHwASIQq4Ob/DexcHnvAd7LDYV/vzG/FzJxx4\nx+taANmXxB6NPVpaA1cNjjX6LRkPHFtbeX2RFWkJDXOFC6n/UZHJBjcjKn2f\nbiC/wS7vkFQD/Y/xVqCO72drl1/EowNNvnUx+Yv1XlHEjN5LeBwjbC3gfF7/\nqq6ysLTpTqNxEVbdAFX7TBy8h5O2IktEA4TODMeZYJQSw+nIdFPjR6yvUEEQ\n4T6lsbfleoh9YFrSOifoFnO7rRX5IyJI6SJ2dfPYLVJAD+BkC2hwK5j/efOl\nMVrSETFSfc/DQHbeLuuGU2xZiYRZnZfPD7XrQX4//s7WF/EYdkAy4+Gygl9o\nd+5gb3Zbd+ivbB/Rx0Uv2+qNR1CQrLi0p2kp4i8/lWohfJsfydnFUDZnTuZH\nQQWdwruHaKpquS1+FBaiZdZkg2HkrXuA7jUKa6BETvstrh31zooJtY4MNyvA\nQvMnk3OYgyTlLgQHp51ng8LyJKL6DpAbEJi3Sy0BrIGOJdqryLM5H6iZ4X/0\nu84o\r\n=i3T6\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDnh/BzzM5Nbv8pvkv++cU094D4oGcWGz/iKnRM0vOw8AIhANffsy4VUPYg2KkI5405Y8lTR9TVfR1uQ+JoJn0IfHBU"}]},"maintainers":[{"name":"paulryan","email":"paul@campgroundbooking.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/angular2-markdown-2.2.0.tgz_1512656633530_0.7404757256153971"},"directories":{}}},"readme":"# Angular 2 Markdown\n\n[![Build Status][travis-badge]][travis-badge-url]\n[![npm][circleci-badge-url]][circleci-url]\n[![version][npm-badge-url]][npm-url]\n[![npm][license-badge-url]][license-url]\n[![npm][dep-badge-url]][dep-url]\n\nSupports Angular2,4,5\n\nSource @ [https://github.com/dimpu/angular2-markdown](https://github.com/dimpu/angular2-markdown)\n\n\n## Table of contents\n1. [Getting Started](#getting-started)\n2. [Installation instructions](#installation-instructions)\n3. [Usage & Demo](#usage--demo)\n4. [Contributing](#contribution)\n5. [License](#license)\n\n# Getting Started\n\nangular2-markdown contains MarkdownModule for Angular.\n\nAdditionally we use [marked.js](https://github.com/chjj/marked/) and [prismjs](http://prismjs.com/) for this component.\n\n# Installation instructions\n\nInstall `angular2-markdown` from `npm`:\n\n```bash\nnpm install angular2-markdown --save\n```\nor using `yarn`:\n\n```bash\nyarn add angular2-markdown\n```\n\n## How to use it with:\n\n- `angular-cli` — please refer to [Getting started with `angular-cli`](https://github.com/dimpu/angular2-markdown/tree/master/docs/getting-started/ng-cli.md)\n- `angular-seed` — please refer to [Getting started with `angular-seed`](https://github.com/dimpu/angular2-markdown/tree/master/docs/getting-started/angular-seed.md)\n- `system.js` (and [Angular 2 QuickStart](https://angular.io/docs/ts/latest/quickstart.html)) — please checkout [sample repository](https://github.com/dimpu/angular2-quickstart)\n- `webpack` — you can view our demo page [source code](https://github.com/dimpu/angular2-markdown/tree/master/demo)\n- `plnkr` — sample available [here](http://bit.ly/2kT0z20)\n- `AoT` using `ngc` and `rollup` — please refer to [How to use `angular2-markdown` in Angular 2 with `AoT` compilation using `ngc` and `rollup`](https://github.com/dimpu/angular2-markdown/tree/master/docs/getting-started/aot.md)\n\n# Usage & Demo\n\nMain source of API documentation and usage scenarios is available at [https://dimpu.github.io/angular2-markdown/](https://dimpu.github.io/angular2-markdown/).\n\n# Contribution\n\nIs very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!\n\n## Quick Guide\n\n### app.module.ts\n\n```typescript\nimport { NgModule } from '@angular/core';\nimport { BrowserModule } from '@angular/platform-browser';\n\nimport { MarkdownModule } from 'angular2-markdown';\nimport { AppComponent } from '../src/app.component';\n\n@NgModule({\n  imports: [\n    BrowserModule,\n    MarkdownModule.forRoot(),\n  ],\n  declarations: [AppComponent],\n  bootstrap: [AppComponent],\n})\n```\n\n### index.html\nIf you want syntax highlighting you need to import the prism css file.\n\nAlternative 1: Import from cdn\n```html\n<head>\n    <meta charset=\"utf-8\">\n    <base href=\"/\">\n\n    <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n    <link rel=\"icon\" type=\"image/x-icon\" href=\"favicon.ico\">\n    <link href=\"https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/themes/prism.min.css\" rel=\"stylesheet\" />\n  </head>\n```\n\nAlternative 2: Download the css file (or copy it from `node_modules/prismjs/themes/`, place it somewhere in your src folder and import\n```html\n<link href=\"/css/prism.min.css\" rel=\"stylesheet\" />\n```\n\nAlternative 3: Include the prism css file in your sass style file\n```css\n@import 'prismjs/themes/prism.css';\n```\n\n### app.component.html\n\n```html\n<div Markdown>\n    ### your markdown code\n</div>\n\n<!-- or use angular component -->\n\n<markdown>\n    ### your markdown code\n</markdown>\n\n<!-- to load from remote URL -->\n\n<div Markdown path=\"/path/to/readme.md\"></div>\n\n<!-- load remote source code with auto syntax highlighting -->\n\n<markdown path=\"/path/to/code.cpp\"></markdown>\n\n<markdown path=\"/path/to/code.java\"></markdown>\n\n<!-- load remote source code from url stored in variable\n(see additional details about variable binding in the next section) -->\n\n<markdown [path]=\"urlVariable\"></markdown>\n```\n\n## Variable binding\n\nNow, with >1.4.x you can bind a variable to the `markdown` component. To do so:\n\n```typescript\n@Component({\n    selector: 'markdown,[Markdown]',\n    template: `\n    <textarea [(ngModel)]=\"textData\"></textarea>\n    <markdown [data]=\"textData\"></markdown>\n    `,\n})\nexport class MyComp {\n  public textData = `## Markdown content data`;\n}\n```\n\n## Marked customization\n\nMarked can be customized/extended by accessing the renderer from the MarkdownService:\n\n```typescript\nimport { MarkdownService } from 'angular2-markdown';\n@Component({\n    selector='my-comp',\n    template: `\n    <markdown>\n     > Block\n     > quote\n     > here\n    </markdown>\n    `,\n})\nexport class MyComp {\n  constructor(private _markdown: MarkdownService) {}\n\n  ngOnInit() {\n    this._markdown.renderer.blockquote = (quote: string) => {\n      return `<blockquote class=\"king-quote\">${quote}</blockquote>`;\n    }\n  }\n```\n\nSee [marked documentation](https://github.com/chjj/marked) for all renderer extension points.\n\n## Example\n\nYou can find a working example inside the `demo` directory.\n\nTo serve it locally, run:\n\n```bash\ngit clone https://github.com/dimpu/angular2-markdown.git\n\nnpm i\n\nnpm run demo.serve\n```\n\n## Todo\n\n- [x] Variable binding\n- [x] Code refactor\n- [x] Write more unit tests\n- [x] Angular 5 support\n- [ ] Module configuration for markdown settings\n- [ ] Module configuration for prismjs settings\n\n<h2 id=\"contributors\">Contributors</h2>\n\nThe following is a list of all the people that have helped build this project. Thanks for your contributions!\n\n[<img alt=\"glenngr\" src=\"https://avatars3.githubusercontent.com/u/1271995?s=460&v=4\" width=\"117\">](https://github.com/dimpu)\n[<img alt=\"glenngr\" src=\"https://avatars2.githubusercontent.com/u/8955488?v=3&s=460\" width=\"117\">](https://github.com/glenngr)\n[<img alt=\"paullryan\" src=\"https://avatars2.githubusercontent.com/u/3146164?v=3&s=460\" width=\"117\">](https://github.com/paullryan)\n\n\n\n\n\n\n\n\n\n\n\n[travis-badge]: https://travis-ci.org/dimpu/angular2-markdown.svg?branch=master\n[travis-badge-url]: https://travis-ci.org/dimpu/angular2-markdown\n[license-url]: https://opensource.org/licenses/MIT\n[license-badge-url]: https://img.shields.io/npm/l/angular2-markdown.svg\n[npm-url]: https://www.npmjs.com/package/angular2-markdown\n[npm-badge-url]: https://img.shields.io/npm/v/angular2-markdown.svg?style=flat\n[circleci-url]: https://circleci.com/gh/dimpu/angular2-markdown/master\n[circleci-badge-url]: https://circleci.com/gh/dimpu/angular2-markdown/tree/master.svg?style=shield&\n[demo-url]: https://github.com/dimpu/angular2-markdown\n[dep-url]: https://david-dm.org/dimpu/angular2-markdown\n[dep-badge-url]: https://david-dm.org/dimpu/angular2-markdown/status.svg\n\n\n\n","maintainers":[{"email":"Jacob.martinez@campingworld.com","name":"jacob-martinez-nomad"},{"email":"alexander.hrst@gmail.com","name":"sshulin"},{"email":"zobrx@rambler.ru","name":"luneneagara"},{"email":"j.bourland@campingworld.com","name":"elybourland-cw"},{"email":"ryan.gross@campingworld.com","name":"ryangross-cw"}],"time":{"modified":"2023-07-05T19:45:58.053Z","created":"2017-12-07T14:23:53.667Z","2.2.0":"2017-12-07T14:23:53.667Z"},"homepage":"https://github.com/dimpu/angular2-markdown#readme","keywords":["ng","angular","angular2","angular4","angular5","ngx","markdown","prismjs"],"repository":{"type":"git","url":"git+ssh://git@github.com/dimpu/angular2-markdown.git"},"author":{"name":"Dimpu Aravind Buddha","email":"buddhaaravind@gmail.com"},"bugs":{"url":"https://github.com/dimpu/angular2-markdown/issues"},"license":"MIT","readmeFilename":"README.md"}