You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-⚡ **New features:**[Async rendering](https://markdown-exit.pages.dev/guide/rendering.html#async-rendering) for all rules includeing syntax highlighting and [more](https://github.com/serkodev/markdown-exit/issues?q=is:issue%20label:features).
15
+
-🔌 **Extensibility:**Extend the markdown syntax, custom rendering with [Plugins](https://markdown-exit.pages.dev/guide/plugins.html).
16
+
-🤝 **Compatibility:**Compatible with markdown-it `v14.1.0` and plugin API.
18
17
19
-
## Quickstart
18
+
## Documentation
20
19
21
-
### Install
20
+
Read the [documentation](https://markdown-exit.pages.dev/) for more details.
22
21
23
-
`v1+` (latest): All new features and may include breaking changes.
22
+
## Installation
23
+
24
+
v1+ [`@latest`](https://www.npmjs.com/package/markdown-exit/v/latest): All new features and may include breaking changes.
24
25
25
26
> [!IMPORTANT]
26
27
> 🚧 **markdown-exit** v1 is currently in **public beta** (`v1.0.0-beta.*`).
@@ -30,40 +31,41 @@ A TypeScript rewrite of [markdown-it](https://github.com/markdown-it/markdown-it
30
31
npm i markdown-exit
31
32
```
32
33
33
-
`v0.x` (legacy): Full compatibility with markdown-it usage while adding TypeScript support, bug fixes and performance improvements. ([v0](https://github.com/serkodev/markdown-exit/tree/v0) branch)
Full compatibility with markdown-it usage while adding TypeScript support, bug fixes and performance improvements. ([v0](https://github.com/serkodev/markdown-exit/tree/v0) branch)
34
38
35
39
```bash
36
40
npm i markdown-exit@legacy
37
41
```
38
42
39
-
### Usage
43
+
</details>
40
44
41
-
#### Named import (recommended)
45
+
##Usage
42
46
43
47
```ts
44
48
import { createMarkdownExit } from'markdown-exit'
45
49
46
50
// factory helper
47
51
const md =createMarkdownExit()
48
-
md.render('# markdown-exit')
52
+
const html =md.render('# markdown-exit')
49
53
```
50
54
51
55
```ts
52
56
import { MarkdownExit } from'markdown-exit'
53
57
54
58
// with the `new` keyword
55
59
const md =newMarkdownExit()
56
-
md.render('# markdown-exit')
60
+
const html =md.render('# markdown-exit')
57
61
```
58
62
59
-
#### Default import
63
+
<details>
64
+
<summary>Default import</summary>
60
65
61
66
> [!NOTE]
62
67
> Default export (with callable constructor support) is retained for markdown-it compatibility, but it may have drawbacks in module interop and tree-shaking.
63
68
64
-
<details>
65
-
<summary>Example</summary>
66
-
67
69
```ts
68
70
importMarkdownExitfrom'markdown-exit'
69
71
@@ -79,22 +81,22 @@ md.render('# markdown-exit')
79
81
```
80
82
</details>
81
83
82
-
#### Documentation
84
+
###Guides
83
85
84
-
Visit markdown-it [API Documentation](https://markdown-it.github.io/markdown-it/) for more info and examples.
markdown-exit is designed to be a drop-in replacement for markdown-it with enhancements. After installing markdown-exit, simply update your imports:
92
+
Drop-in replacement for markdown-it with enhancements, see [Migration Guide](https://markdown-exit.pages.dev/guide/migrate-from-markdown-it.html) for details.
89
93
90
94
```diff
91
95
- import MarkdownIt from 'markdown-it'
92
96
+ import MarkdownExit from 'markdown-exit'
93
97
```
94
98
95
-
Everything else should work as expected. ✨
96
-
97
-
## References / Thanks
99
+
## Credits
98
100
99
101
This project owes its foundation to the [markdown-it](https://github.com/markdown-it/markdown-it) community and all its [contributors](https://github.com/markdown-it/markdown-it/graphs/contributors).
-⚡ **New features:**[Async rendering](https://markdown-exit.pages.dev/guide/rendering.html#async-rendering) for all rules includeing syntax highlighting and [more](https://github.com/serkodev/markdown-exit/issues?q=is:issue%20label:features).
15
+
-🔌 **Extensibility:**Extend the markdown syntax, custom rendering with [Plugins](https://markdown-exit.pages.dev/guide/plugins.html).
16
+
-🤝 **Compatibility:**Compatible with markdown-it `v14.1.0` and plugin API.
18
17
19
-
## Quickstart
18
+
## Documentation
20
19
21
-
### Install
20
+
Read the [documentation](https://markdown-exit.pages.dev/) for more details.
22
21
23
-
`v1+` (latest): All new features and may include breaking changes.
22
+
## Installation
23
+
24
+
v1+ [`@latest`](https://www.npmjs.com/package/markdown-exit/v/latest): All new features and may include breaking changes.
24
25
25
26
> [!IMPORTANT]
26
27
> 🚧 **markdown-exit** v1 is currently in **public beta** (`v1.0.0-beta.*`).
@@ -30,40 +31,41 @@ A TypeScript rewrite of [markdown-it](https://github.com/markdown-it/markdown-it
30
31
npm i markdown-exit
31
32
```
32
33
33
-
`v0.x` (legacy): Full compatibility with markdown-it usage while adding TypeScript support, bug fixes and performance improvements. ([v0](https://github.com/serkodev/markdown-exit/tree/v0) branch)
Full compatibility with markdown-it usage while adding TypeScript support, bug fixes and performance improvements. ([v0](https://github.com/serkodev/markdown-exit/tree/v0) branch)
34
38
35
39
```bash
36
40
npm i markdown-exit@legacy
37
41
```
38
42
39
-
### Usage
43
+
</details>
40
44
41
-
#### Named import (recommended)
45
+
##Usage
42
46
43
47
```ts
44
48
import { createMarkdownExit } from'markdown-exit'
45
49
46
50
// factory helper
47
51
const md =createMarkdownExit()
48
-
md.render('# markdown-exit')
52
+
const html =md.render('# markdown-exit')
49
53
```
50
54
51
55
```ts
52
56
import { MarkdownExit } from'markdown-exit'
53
57
54
58
// with the `new` keyword
55
59
const md =newMarkdownExit()
56
-
md.render('# markdown-exit')
60
+
const html =md.render('# markdown-exit')
57
61
```
58
62
59
-
#### Default import
63
+
<details>
64
+
<summary>Default import</summary>
60
65
61
66
> [!NOTE]
62
67
> Default export (with callable constructor support) is retained for markdown-it compatibility, but it may have drawbacks in module interop and tree-shaking.
63
68
64
-
<details>
65
-
<summary>Example</summary>
66
-
67
69
```ts
68
70
importMarkdownExitfrom'markdown-exit'
69
71
@@ -79,22 +81,22 @@ md.render('# markdown-exit')
79
81
```
80
82
</details>
81
83
82
-
#### Documentation
84
+
###Guides
83
85
84
-
Visit markdown-it [API Documentation](https://markdown-it.github.io/markdown-it/) for more info and examples.
markdown-exit is designed to be a drop-in replacement for markdown-it with enhancements. After installing markdown-exit, simply update your imports:
92
+
Drop-in replacement for markdown-it with enhancements, see [Migration Guide](https://markdown-exit.pages.dev/guide/migrate-from-markdown-it.html) for details.
89
93
90
94
```diff
91
95
- import MarkdownIt from 'markdown-it'
92
96
+ import MarkdownExit from 'markdown-exit'
93
97
```
94
98
95
-
Everything else should work as expected. ✨
96
-
97
-
## References / Thanks
99
+
## Credits
98
100
99
101
This project owes its foundation to the [markdown-it](https://github.com/markdown-it/markdown-it) community and all its [contributors](https://github.com/markdown-it/markdown-it/graphs/contributors).
0 commit comments