angular2-markdown

[![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]

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
angular2-markdown
264342.2.36 years ago8 years agoMinified + gzip package size for angular2-markdown in KB

Popular Searches

Readme

Angular 2 Markdown
!Build Statustravis-badgetravis-badge-url !npmcircleci-badge-urlcircleci-url !versionnpm-badge-urlnpm-url !npmlicense-badge-urllicense-url !npmdep-badge-urldep-url
Notice: This package is depricated use https://www.npmjs.com/package/ngx-md instead.
Supports Angular2,4,5
Source @ https://github.com/dimpu/angular2-markdown

Table of contents

  1. Getting Started
  2. Installation instructions
  3. Usage & Demo
  4. Contributing
  5. License
Getting Started
angular2-markdown contains MarkdownModule for Angular.
Additionally we use marked.js and prismjs for this component.
Installation instructions
Install angular2-markdown from npm:
npm install angular2-markdown --save
or using yarn:
yarn add angular2-markdown

How to use it with:

Usage & Demo
Main source of API documentation and usage scenarios is available at https://dimpu.github.io/angular2-markdown/.
Contribution
Is 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!

Quick Guide

app.module.ts

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { MarkdownModule } from 'angular2-markdown';
import { AppComponent } from '../src/app.component';

@NgModule({
  imports: [
    BrowserModule,
    MarkdownModule.forRoot(),
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})

index.html

If you want syntax highlighting you need to import the prism css file.
Alternative 1: Import from cdn 
<head>
    <meta charset="utf-8">
    <base href="/">

    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link rel="icon" type="image/x-icon" href="favicon.ico">
    <link href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.6.0/themes/prism.min.css" rel="stylesheet" />
  </head>

Alternative 2: Download the css file (or copy it from node_modules/prismjs/themes/, place it somewhere in your src folder and import 
<link href="/css/prism.min.css" rel="stylesheet" />

Alternative 3: Include the prism css file in your sass style file 
@import 'prismjs/themes/prism.css';

app.component.html

<div Markdown>
    ### your markdown code
</div>

<!-- or use angular component -->

<markdown>
    ### your markdown code
</markdown>

<!-- to load from remote URL -->

<div Markdown path="/path/to/readme.md"></div>

<!-- load remote source code with auto syntax highlighting -->

<markdown path="/path/to/code.cpp"></markdown>

<markdown path="/path/to/code.java"></markdown>

<!-- load remote source code from url stored in variable
(see additional details about variable binding in the next section) -->

<markdown [path]="urlVariable"></markdown>

Variable binding

Now, with >1.4.x you can bind a variable to the markdown component. To do so:
@Component({
    selector: 'markdown,[Markdown]',
    template: `
    <textarea [(ngModel)]="textData"></textarea>
    <markdown [data]="textData"></markdown>
    `,
})
export class MyComp {
  public textData = `## Markdown content data`;
}

Marked customization

Marked can be customized/extended by accessing the renderer from the MarkdownService:
import { MarkdownService } from 'angular2-markdown';
@Component({
    selector='my-comp',
    template: `
    <markdown>
     > Block
     > quote
     > here
    </markdown>
    `,
})
export class MyComp {
  constructor(private _markdown: MarkdownService) {}

  ngOnInit() {
    this._markdown.renderer.blockquote = (quote: string) => {
      return `<blockquote class="king-quote">${quote}</blockquote>`;
    }
  }

See marked documentation for all renderer extension points.

Example

You can find a working example inside the demo directory.
To serve it locally, run:
git clone https://github.com/dimpu/angular2-markdown.git

npm i

npm run demo.serve

Todo

  • x Variable binding
  • x Code refactor
  • x Write more unit tests
  • x Angular 5 support
  • Module configuration for markdown settings
  • Module configuration for prismjs settings

Contributors


The following is a list of all the people that have helped build this project. Thanks for your contributions!
glenngr glenngr paullryan