https://github.com/angeeks/marked
Another markdown wrapper component for Angular, build with simplicity and clarity in mind. 🎉
https://github.com/angeeks/marked
angular markdown npm
Last synced: 20 days ago
JSON representation
Another markdown wrapper component for Angular, build with simplicity and clarity in mind. 🎉
- Host: GitHub
- URL: https://github.com/angeeks/marked
- Owner: angeeks
- Created: 2018-06-04T13:19:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-12T16:29:55.000Z (about 8 years ago)
- Last Synced: 2025-10-10T13:43:17.689Z (9 months ago)
- Topics: angular, markdown, npm
- Language: TypeScript
- Homepage: https://angeeks.github.io/marked/
- Size: 542 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
Awesome Lists containing this project
README
# ngk-markdown aka ngk-md
[](https://travis-ci.org/angeeks/marked)
[](https://www.npmjs.com/package/@angeeks/md)
Another markdown wrapper component for Angular, build with simplicity and clarity in mind.
Note that by default, it use `marked.js` as the parser (that's why this project called), see [below](#replace-parser) to use your own parser.
# Installation
```
npm i -P @angeeks/md
```
# Usage
```diff
// app.module.ts
+import { MdModule } from '@angeeks/md';
@NgModule({
imports: [
+ MdModule
]
})
export class AppModule {}
```
```diff
```
# Replace parser
```diff
// app.module.ts
+import { mdParser, Parser } from '@angeeks/md';
+export function yourMarkdownParser(): Parser {
+ return { parse };
+}
@NgModule({
imports: [
MdModule
],
providers: [
+ { provide: mdParser, useFactory: yourMarkdownParser }
]
}
})
export class AppModule {}
```