Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sibiraj-s committed Jul 26, 2022
1 parent af81c5e commit 0c0b8b9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 36 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

## Getting Started

[demo] | [edit on stackblitz][stackblitz] | [documentation] | [migrating from v4][migration] | [migrating from other editors][migration]
[demo] | [edit on stackblitz][stackblitz] | [documentation] | [migrating from other editors][migration]

### Installation

Expand Down Expand Up @@ -149,15 +149,15 @@ Mostly works on all Evergreen-Browsers like

## Angular Compatibility

Angular 13+.
Angular 14+.

## Collaborative Editing

See https://sibiraj-s.github.io/ngx-editor/#/collab

## Icons

Icons are from https://material.io/resources/icons/
Icons are from https://fonts.google.com/icons

## Contributing

Expand All @@ -168,4 +168,3 @@ All contributions are welcome. See [CONTRIBUTING.md](./.github/CONTRIBUTING.md)
[documentation]: https://sibiraj-s.github.io/ngx-editor
[demo]: https://ngx-editor.stackblitz.io/
[stackblitz]: https://stackblitz.com/edit/ngx-editor
[migration]: https://sibiraj-s.github.io/ngx-editor/#/migration
38 changes: 6 additions & 32 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</p>
<p align="center">Rich Text Editor for angular using ProseMirror</p>
<p align="center">
<a href="https://travis-ci.org/sibiraj-s/ngx-editor">
<a href="https://github.com/sibiraj-s/ngx-editor/actions">
<img alt="Tests" src="https://github.com/sibiraj-s/ngx-editor/workflows/Tests/badge.svg">
</a>
<a href="https://www.npmjs.com/package/ngx-editor">
Expand All @@ -19,14 +19,15 @@
<a href="https://www.npmjs.com/package/ngx-editor">
<img alt="npm" src="https://badgen.net/npm/dt/ngx-editor">
</a>
<br />
<a href="https://github.com/sibiraj-s/ngx-editor/blob/master/LICENSE">
<img alt="licence" src="https://badgen.net/npm/license/ngx-editor">
</a>
</p>

## Getting Started

[demo] | [edit on stackblitz][stackblitz] | [documentation] | [migrating from v4][migration] | [migrating from other editors][migration]
[demo] | [edit on stackblitz][stackblitz] | [documentation] | [migrating from other editors][migration]

### Installation

Expand Down Expand Up @@ -127,37 +128,11 @@ You can specify locals to be used in the editor
```ts
NgxEditorModule.forRoot({
locals: {
// menu
bold: 'Bold',
italic: 'Italic',
code: 'Code',
underline: 'Underline',
strike: 'Strike',
blockquote: 'Blockquote',
bullet_list: 'Bullet List',
ordered_list: 'Ordered List',
heading: 'Heading',
h1: 'Header 1',
h2: 'Header 2',
h3: 'Header 3',
h4: 'Header 4',
h5: 'Header 5',
h6: 'Header 6',
align_left: 'Left Align',
align_center: 'Center Align',
align_right: 'Right Align',
align_justify: 'Justify',
text_color: 'Text Color',
background_color: 'Background Color',

// pupups, forms, others...
url: 'URL',
text: 'Text',
openInNewTab: 'Open in new tab',
insert: 'Insert',
altText: 'Alt Text',
title: 'Title',
remove: 'Remove',
// ...
},
});
```
Expand All @@ -174,19 +149,18 @@ Mostly works on all Evergreen-Browsers like

## Angular Compatibility

Angular 13+.
Angular 14+.

## Collaborative Editing

See https://sibiraj-s.github.io/ngx-editor/#/collab

## Icons

Icons are from https://material.io/resources/icons/
Icons are from https://fonts.google.com/icons

[npm]: https://www.npmjs.com/
[yarn]: https://yarnpkg.com/lang/en/
[documentation]: https://sibiraj-s.github.io/ngx-editor
[demo]: https://ngx-editor.stackblitz.io/
[stackblitz]: https://stackblitz.com/edit/ngx-editor
[migration]: https://sibiraj-s.github.io/ngx-editor/#/migration

0 comments on commit 0c0b8b9

Please sign in to comment.