https://github.com/SalathielGenese/ngx-mdx
Take Angular lifecycle to Markdown, for a seamless experience
https://github.com/SalathielGenese/ngx-mdx
Last synced: 12 days ago
JSON representation
Take Angular lifecycle to Markdown, for a seamless experience
- Host: GitHub
- URL: https://github.com/SalathielGenese/ngx-mdx
- Owner: SalathielGenese
- Created: 2025-05-03T21:29:54.000Z (13 days ago)
- Default Branch: main
- Last Pushed: 2025-05-03T22:25:34.000Z (13 days ago)
- Last Synced: 2025-05-03T22:25:51.197Z (13 days ago)
- Language: TypeScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-angular - ngx-mdx - Take Angular lifecycle to Markdown for a seamless experience. (Table of contents / Third Party Components)
- trackawesomelist - ngx-mdx (⭐1) - Take Angular lifecycle to Markdown for a seamless experience. (Recently Updated / [May 05, 2025](/content/2025/05/05/README.md))
README
# `ngx-mdx`
The React vibrant ecosystem makes Markdown integration seamless with MDX.
So this project is all about bringing a similar experience to Angular,
with as less hurdle as we can.
## Usage
### Install
```shell
# npm install npx-mdx
# yarn add npx-mdx
pnpm add npx-mdx
```
### API
`ngx-mdx` exposes:
+ one component:
+ ```typescript
// Component Selectors: ngx-mdx, ngxMdx
import {MdxComponent} from "ngx-mdx";
```
+ two directives:
+ ```typescript
// Directive Selectors: [ngx-mdx-ignore], [ngxMdxIgnore]
import {MdxIgnoreDirective} from "ngx-mdx";
// Useful to ignore a DOM tree starting on the node it is applied on.
```
+ ```typescript
// Directive Selectors: [ngx-mdx-inline], [ngxMdxInline]
import {MdxIgnoreDirective} from "ngx-mdx";
```
### Templating
```angular2html
Hello **world**!
Hello world!
```
Markdown in nested DOM:
```angular2html
Hello dancing **world**!
Hello
dancing world
!
```
> **NOTE:** You may have noticed those extract `
` tags.
> You can inline the rendering and rid of them...
>
> It works on ngx-mdx hosts:
> ```angular2html
>
> Hello **world**!
>
>
> Hello world!
> ```
>
>
> But also when Markdown in nested DOM:
> ```angular2html
>
> Hello dancing **world**!
>
>
>
Hello
dancing world!
> ```
## Licencing
This project is delivered under MIT Licence.
## Contributing
You are encouraged to:
+ Open issues, with your Angular/ngx-mdx versions
+ Fork this repository and submit feature requests