Skip to content

Commit 0abafdd

Browse files
authored
docs: fix some typos and improve text
1 parent 52a5fd5 commit 0abafdd

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

readme.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![npm version](https://badge.fury.io/js/angular-markdown-editor.svg)](//npmjs.com/package/angular-markdown-editor)
55
[![NPM downloads](https://img.shields.io/npm/dy/angular-markdown-editor.svg)](https://npmjs.org/package/angular-markdown-editor)
66

7-
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, ...).
88

99
## License
1010
[MIT License](LICENSE)
@@ -28,10 +28,11 @@ Here is the list of required dependencies
2828
- [jQuery](http://jquery.com/) _(required for Bootstrap-Markdown editor)_
2929
- [Bootstrap >=4.x](https://getbootstrap.com/)
3030

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.
3333

3434
### Demo page
35+
Standalone demo project, with Angular 14 & Bootstrap 5, that you can clone to easily get started
3536
- [Bootstrap 5 demo](https://ghiscoding.github.io/angular-markdown-editor) / [examples repo](https://github.com/ghiscoding/angular-markdown-editor-demo)
3637

3738
## Installation
@@ -47,8 +48,8 @@ npm install angular-markdown-editor
4748
yarn add angular-markdown-editor
4849
```
4950

50-
### Modify the `angular.json` file
51-
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.
5253
Also make sure to include the proper 3rd party javascript libraries in your `scripts` as shown below.
5354

5455
```json
@@ -65,7 +66,7 @@ Also make sure to include the proper 3rd party javascript libraries in your `scr
6566

6667
#### When using `ngx-markdown` and/or `Prism.js`
6768
`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:
6970
```json
7071
"styles": [
7172
"node_modules/prismjs/themes/prism.css"
@@ -304,4 +305,4 @@ export class MyComponent {
304305
}
305306
```
306307

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

Comments
 (0)