Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dimpu/ngx-md

Angular(ngx) directive for parsing markdown content in your web application.
https://github.com/dimpu/ngx-md

angular-module markdown marked ng ng2 prismjs

Last synced: 4 days ago
JSON representation

Angular(ngx) directive for parsing markdown content in your web application.

Host: GitHub
URL: https://github.com/dimpu/ngx-md
Owner: dimpu
Created: 2016-06-24T05:11:04.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2025-01-28T19:19:43.000Z (13 days ago)
Last Synced: 2025-01-31T12:55:15.595Z (11 days ago)
Topics: angular-module, markdown, marked, ng, ng2, prismjs
Language: TypeScript
Homepage: https://dimpu.github.io/ngx-md/
Size: 31.2 MB
Stars: 267
Watchers: 8
Forks: 82
Open Issues: 35
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-angular - ngx-md - Angular(ngx) directive for parsing markdown content in your web application. (Uncategorized / Uncategorized)
awesome-angular-components - dimpu/ngx-md - Angular(ngx) directive for parsing markdown content in your web application. (UI Components / Markdown)
awesome-angular - ngx-md - Angular directive for parsing markdown content in your web application. (Table of contents / Third Party Components)
fucking-awesome-angular - ngx-md - Angular directive for parsing markdown content in your web application. (Table of contents / Third Party Components)

README

        # Angular Markdown (NgxMd)

[![Build Status][cirrus-ci-badge]][cirrus-ci-badge-url]

[![npm][circleci-badge-url]][circleci-url]

[![version][npm-badge-url]][npm-url]

[![npm][license-badge-url]][license-url]

[![npm][opencollective]][opencollective]

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md?ref=badge_shield)

Supports Angular2,4,5,6,7,12,18

Source @ [https://github.com/dimpu/ngx-md](https://github.com/dimpu/ngx-md)

## Table of contents

1. [Getting Started](#getting-started)

2. [Installation instructions](#installation-instructions)

3. [Usage & Demo](#usage--demo)

4. [Contributing](#contribution)

5. [License](#license)

# Getting Started

ngx-md contains NgxMdModule for Angular.

Additionally we use [marked.js](https://github.com/chjj/marked/) and [prismjs](http://prismjs.com/) for this component.

# Installation instructions

Install `ngx-md` from `npm`:

```bash

npm install ngx-md --save

```

or using `yarn`:

```bash

yarn add ngx-md

```

## How to use it with:

- `angular-cli` — please refer to [Getting started with `angular-cli`](https://github.com/dimpu/ngx-md/tree/master/docs/getting-started/ng-cli.md)

- `angular-seed` — please refer to [Getting started with `angular-seed`](https://github.com/dimpu/ngx-md/tree/master/docs/getting-started/angular-seed.md)

- `system.js` (and [Angular 2 QuickStart](https://angular.io/docs/ts/latest/quickstart.html)) — please checkout [sample repository](https://github.com/dimpu/angular2-quickstart)

- `webpack` — you can view our demo page [source code](https://github.com/dimpu/ngx-md/tree/master/demo)

- `stackblitz` — sample available [here](https://stackblitz.com/edit/ngx-md-exmaple)

- `AoT` using `ngc` and `rollup` — please refer to [How to use `ngx-md` in Angular 2 with `AoT` compilation using `ngc` and `rollup`](https://github.com/dimpu/ngx-md/tree/master/docs/getting-started/aot.md)

# Usage & Demo

Main source of API documentation and usage scenarios is available at [https://dimpu.github.io/ngx-md/](https://dimpu.github.io/ngx-md/).

# 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

This library has dependency on **HttpClientModule**. It should be always provided in your application.

```typescript

import { NgModule } from '@angular/core';

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

import { NgxMdModule } from 'ngx-md';

import { HttpClientModule } from '@angular/common'

import { AppComponent } from '../src/app.component';

@NgModule({

  imports: [

    BrowserModule,

    HttpClientModule,

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

```html

    

    

    

    

    

  

```

Alternative 2: Download the css file (or copy it from `node_modules/prismjs/themes/`, place it somewhere in your src folder and import

```html

```

Alternative 3: Include the prism css file in your sass style file

```css

@import 'prismjs/themes/prism.css';

```

To support sytnax helight for other langugage you need to include

```ts

// import 'prismjs/prism';

import 'prismjs/components/prism-c';

import 'prismjs/components/prism-cpp';

import 'prismjs/components/prism-csharp';

import 'prismjs/components/prism-css';

import 'prismjs/components/prism-diff';

import 'prismjs/components/prism-java';

import 'prismjs/components/prism-javascript';

import 'prismjs/components/prism-perl';

...

...

...

```

### app.component.html

```html



    ### your markdown code



    ### your markdown code



```

## Variable binding

Now, with >1.4.x you can bind a variable to the `markdown` component. To do so:

```typescript

@Component({

    selector: 'app-root',

    template: `

    

    

    `,

})

export class MyComp {

  public textData = `## Markdown content data`;

}

```

## Marked customization

Marked can be customized/extended by accessing the renderer from the MarkdownService:

```typescript

import { NgxMdService } from 'ngx-md';

@Component({

    selector='my-comp',

    template: `

    

     > Block

     > quote

     > here

    

    `,

})

export class MyComp {

  constructor(private _markdown: NgxMdService) {}

  ngOnInit() {

    this._markdown.renderer.blockquote = (quote: string) => {

      return `
${quote}`;

    }

  }

```

See [marked documentation](https://github.com/chjj/marked) for all renderer extension points.

## Example

You can find a working example inside the `demo` directory.

To serve it locally, run:

```bash

git clone https://github.com/dimpu/ngx-md.git

npm i

npm run demo.serve

```

## Todo

- [x] Variable binding

- [x] Code refactor

- [x] Write more unit tests

- [x] Angular 5,6,7 support

- [ ] Angular schemantics support

- [ ] Module configuration for markdown settings

- [ ] Module configuration for prismjs settings

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md?ref=badge_large)

[cirrus-ci-badge]: https://api.cirrus-ci.com/github/dimpu/ngx-md.svg?branch=master

[cirrus-ci-badge-url]: https://api.cirrus-ci.com/github/dimpu/ngx-md

[license-url]: https://opensource.org/licenses/MIT

[license-badge-url]: https://img.shields.io/npm/l/ngx-md.svg

[npm-url]: https://www.npmjs.com/package/ngx-md

[npm-badge-url]: https://img.shields.io/npm/v/ngx-md.svg?style=flat

[circleci-url]: https://circleci.com/gh/dimpu/ngx-md/master

[circleci-badge-url]: https://circleci.com/gh/dimpu/ngx-md/tree/master.svg?style=shield&

[demo-url]: https://github.com/dimpu/ngx-md

[dep-url]: https://david-dm.org/dimpu/ngx-md

[dep-badge-url]: https://david-dm.org/dimpu/ngx-md/status.svg

[opencollective]: https://opencollective.com/ngx-md/tiers/backer/badge.svg?label=backer&color=brightgreen

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdimpu%2Fngx-md?ref=badge_large)