Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
ngx-markdown
Advanced tools
Angular 2+ library that uses marked to parse markdown to html combined with Prism.js for synthax highlights
ngx-markdown is an Angular library that allows you to use Markdown in your Angular applications. It provides a set of directives and services to easily render Markdown content.
Render Markdown from a string
This feature allows you to render Markdown content directly from a string within your Angular templates.
<markdown># Hello World</markdown>
Render Markdown from a URL
This feature allows you to render Markdown content from an external file by specifying the URL.
<markdown src="path/to/markdown/file.md"></markdown>
Render Markdown from a variable
This feature allows you to bind a variable containing Markdown content to the markdown component.
<markdown [data]="markdownContent"></markdown>
Syntax highlighting
This feature allows you to enable syntax highlighting for code blocks within your Markdown content.
<markdown [data]="markdownContent" [lineNumbers]="true"></markdown>
Marked is a low-level Markdown compiler for parsing Markdown without caching or blocking for long periods of time. It is more lightweight compared to ngx-markdown and can be used in various JavaScript environments, not just Angular.
Showdown is a bidirectional Markdown to HTML to Markdown converter written in JavaScript. It is highly customizable and can be used in both client-side and server-side applications. Unlike ngx-markdown, it is not specifically designed for Angular.
React-markdown is a Markdown component for React. It allows you to render Markdown content in React applications. While ngx-markdown is tailored for Angular, react-markdown is specifically designed for React.
ngx-markdown is an Angular 2+ library that uses marked to parse markdown to html combined with Prism.js for synthax highlights.
Demo available @ jfcere.github.io/ngx-markdown
Use the following command to add ngx-markdown library to your package.json
file.
npm install ngx-markdown --save
To activate Prism.js synthax highlight you will need to choose a css theme file from node_modules/prismjs/themes
directory and add it to your application along with @types/prismjs
types file.
Note that you can also find additional themes by browsing the web such as Prism-Themes or Mokokai for example.
If you are using Angular CLI you can follow the example below...
"styles": [
"styles.css",
+ "../node_modules/prismjs/themes/prism-okaidia.css"
],
"compilerOptions": {
"types": [
+ "prismjs"
]
},
You must import MarkdownModule
inside your module to be able to use markdown
component and/or directive.
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
+ import { MarkdownModule } from 'ngx-markdown';
import { HomeComponent } from './home.component';
@NgModule({
imports: [
CommonModule,
+ MarkdownModule.forRoot(),
],
declarations: [HomeComponent],
})
ngx-markdown provides one component and one directive to parse your markdown to your web application.
You can use markdown
component to either parse static markdown directly from your html markup, load the content from a remote url using src
property or bind a variable to your component using data
property.
<!-- static markdown -->
<markdown>
# Markdown
</markdown>
<!-- loaded from remote url -->
<markdown [src]="'path/to/file.md'"></markdown>
<!-- variable binding -->
<markdown [data]="markdown"></markdown>
The same way the component works, you can use markdown
directive to accomplish the same thing.
<!-- static markdown -->
<div markdown>
# Markdown
</div>
<!-- loaded from remote url -->
<div markdown [src]="'path/to/file.md'"></div>
<!-- variable binding -->
<div markdown [data]="markdown"></div>
When using static markdown you are responsible to provide the code block with related language.
<markdown>
+ ```typescript
const myProp: string = 'value';
+ ```
</markdown>
When using remote url ngx-markdown will use file extension to automatically resolve the code language.
<!-- will use html highlights -->
<markdown [src]="'path/to/file.html'"></markdown>
<!-- will use php highlights -->
<markdown [src]="'path/to/file.php'"></markdown>
When using variable binding you can optionally use language
pipe to specify the language of the variable content (default value is markdown when pipe is not used).
<markdown [data]="markdown | language : 'typescript'"></markdown>
A demo is available @ https://jfcere.github.io/ngx-markdown and it source code can be found inside the src/app/markdown-demo
directory.
The following commands will clone the repository, install npm dependencies and serve the application @ http://localhost:4200
git clone https://github.com/jfcere/ngx-markdown.git
npm install
ng serve
Building with AoT is part of the CI and is tested every time a commit occurs so you don't have to worry at all.
Here is the list of tasks that will be done on this library in a near future ...
Contributions are always welcome, just make sure that ...
Licensed under MIT.
FAQs
Angular library that uses marked to parse markdown to html combined with Prism.js for synthax highlights
The npm package ngx-markdown receives a total of 121,128 weekly downloads. As such, ngx-markdown popularity was classified as popular.
We found that ngx-markdown demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.