angular2-markdown

Angular 2 Markdown

Source @ https://github.com/dimpu/angular2-markdown

Table of contents

• Getting Started
• Installation instructions
• Usage & Demo
• Contributing
• License

Getting Started

angular2-markdown contains MarkdownModule for Angular 2.

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:

• angular-cli — please refer to Getting started with angular-cli
• angular-seed — please refer to Getting started with angular-seed
• system.js (and Angular 2 QuickStart) — please checkout sample repository
• webpack — you can view our demo page source code
• plnkr — sample available here
• AoT using ngc and rollup — please refer to How to use angular2-markdown in Angular 2 with AoT compilation using ngc and rollup

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.js

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],
})

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>

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`;
}

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

• Variable binding
• Code refactor
• Write more unit tests
• Module configuration for markdown settings
• Module configuration for prismjs settings