Skip to content

Angular 2 directive for parsing markdown content in your web application.

License

Notifications You must be signed in to change notification settings

juergen-vogel/angular2-markdown

 
 

Repository files navigation

Angular 2 Markdown

Build Status npm version npm

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

Demo @ https://dimpu.github.io/angular2-markdown/

Setup

npm i angular2-markdown --save

How to use it

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,
  ],
  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 syantax helight.

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

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

Example

You can found the working example inside the src/app/demo directory.

git clone https://github.com/dimpu/angular2-markdown.git

npm i

ng serve

now you should see working example at http://localhost:4200

About

Angular 2 directive for parsing markdown content in your web application.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 42.7%
  • JavaScript 33.0%
  • HTML 23.2%
  • Other 1.1%