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
In this package we will use a few libraries and tools to make a more convenient "all in one" WYSIWYG Markdown Editor with preview. All of that with a simple Angular Component. This can be useful for online documentation and many other reasons (docs, blog, ...).
7
+
This package includes a few libraries and tools to make a more convenient "all in one" WYSIWYG Markdown Editor with preview. All of that bundled into a simple Angular Component. This package can be useful for online documentation and/or anything similar (docs, blog, ...).
8
8
9
9
## License
10
10
[MIT License](LICENSE)
@@ -28,10 +28,11 @@ Here is the list of required dependencies
28
28
-[jQuery](http://jquery.com/)_(required for Bootstrap-Markdown editor)_
29
29
-[Bootstrap >=4.x](https://getbootstrap.com/)
30
30
31
-
### Nice to have Dependencies
32
-
It's a "nice to have" extra but not a hard dependencies, which is the [ngx-markdown](https://github.com/jfcere/ngx-markdown)lib. It is used in the demo of this lib, but technically you could plug any other lib you wish for dealing with the markdown preview.
31
+
### Nice to have Dependency
32
+
It's a "nice to have" extra, but not a hard dependency, which is to include the [ngx-markdown](https://github.com/jfcere/ngx-markdown)library. It is used in the demo of this package, but technically you could plug any other library that you wish for dealing with the markdown preview.
33
33
34
34
### Demo page
35
+
Standalone demo project, with Angular 14 & Bootstrap 5, that you can clone to easily get started
You need to add CSS Styles for the Bootstrap, Markdown Editor and Font-Awesome v4.7.
51
+
### Modify your`angular.json`config
52
+
You need to add the necessary CSS Styles for Bootstrap, Markdown Editor and Font-Awesome v4.7.
52
53
Also make sure to include the proper 3rd party javascript libraries in your `scripts` as shown below.
53
54
54
55
```json
@@ -65,7 +66,7 @@ Also make sure to include the proper 3rd party javascript libraries in your `scr
65
66
66
67
#### When using `ngx-markdown` and/or `Prism.js`
67
68
`Prism.js` uses separate javascript file for each language, so you'll need to add them yourself.
68
-
For example, below we are adding the highlight for`C#`, `JavaScript` and `TypeScript`:
69
+
For example, we are showing below the highlight of`C#`, `JavaScript` and `TypeScript` language:
69
70
```json
70
71
"styles": [
71
72
"node_modules/prismjs/themes/prism.css"
@@ -304,4 +305,4 @@ export class MyComponent {
304
305
}
305
306
```
306
307
307
-
**Note** I could not find a way to change the language dynamically, so it seems that we would have to destroy the component and re-create it for switching the language/locale.
308
+
**Note** I could not find a way to change the language dynamically, so it seems that we would have to destroy the component and re-create it for switching the language/locale.
0 commit comments