Table of Contents

1. Features
2. Installation
3. Choose the version
4. Usage
5. News
6. Contributing
7. License

:boom: Features :boom:

• Angular Module to import this library
• supports all recommended Angular Compiler Options
• compliant to Angular Package Format specifications
• use Semantic versioning 2.0.0 also known as 'semver'
• official example with angular-cli

:package: Installation :package:

• npm install --save @ks89/ngx-codemirror6

Also, you need Codemirror packages as peer dependencies

npm i --save codemirror
npm i --save @codemirror/lang-html
npm i --save @codemirror/lang-javascript
npm i --save @codemirror/lang-sass
npm i --save @codemirror/state
npm i --save @codemirror/view

:warning: Choose the right version :warning:

| | @ks89/ngx-codemirror6 | |------------|:---------------------:| | Angular 16 | = 1.0.0 | | Angular 18 | >= 2.0.1 |

Usage

Check the official example in ./src.

:fire: News :fire:

• 30/05/2024 - 2.0.1 - @ks89/ngx-codemirror6 - HERE
• 30/05/2024 - 2.0.0 - @ks89/ngx-codemirror6 - HERE
• 17/08/2019 - 1.0.0 - @ks89/ngx-codemirror6 - HERE

:computer: Contributing :computer:

Check CONTRIBUTING.md in this repository. To understand how to contribute to an open source project, HERE you can find useful information.

When you create a pull request, please, format your code to be consistent with the existing code. I suggest to use WebStorm as IDE and when you commit don't use a third party software, but the official command line git. In this way, prettier will run using my configuration and it will auto-format the code. If it fails, add files with git add . again and retry.

:copyright: License :copyright:

The MIT License (MIT)

Copyright (c) 2023-2024 Stefano Cappa

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Created by Stefano Cappa

⬆ back to top