You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
monaco-editor/README.md

81 lines
1.9 KiB
Markdown

9 years ago
# Monaco Languages
Colorization and configuration supports for multiple languages for the Monaco Editor:
![monaco-languages](https://cloud.githubusercontent.com/assets/5047891/15938606/1fd4bac6-2e74-11e6-8839-d455da8bc8a7.gif)
* bat
* coffee script
* cpp
* csharp
* fsharp
* go
* html
9 years ago
* ini
* jade
* lua
* objective-c
* postiats
9 years ago
* php
9 years ago
* powershell
* python
* r
* ruby
* sql
* swift
* vb
* xml
Also `css` dialects:
* css
* less
* scss
9 years ago
## Issues
Please file issues concering `monaco-languages` in the [`monaco-editor`-repository](https://github.com/Microsoft/monaco-editor/issues).
9 years ago
## Installing
This npm module is bundled and distributed in the [monaco-editor](https://www.npmjs.com/package/monaco-editor) npm module.
9 years ago
## Dev: cheat sheet
9 years ago
9 years ago
* initial setup with `npm install .`
9 years ago
* compile with `npm run watch`
* test with `npm run test`
* bundle with `npm run prepublish`
9 years ago
## Dev: Adding a new language
* create `$/src/myLang.ts`
* create `$/test/myLang.test.ts`
* update tsconfig.json with `$> node_modules/.bin/tscg .`
* restart compilation with `$> npm run watch`
* edit `$/src/monaco.contribution.ts` and register your new language:
9 years ago
```js
9 years ago
registerLanguage({
id: 'sql',
extensions: [ '.sql' ],
aliases: [ 'SQL' ],
module: './sql'
});
9 years ago
```
9 years ago
* edit `$/test/all.js` and load your new language while testing
9 years ago
```js
9 years ago
'out/test/sql.test',
9 years ago
```
9 years ago
* edit `$/gulpfile.js` and ship your new language
9 years ago
```js
9 years ago
bundleOne('src/sql'),
9 years ago
```
9 years ago
9 years ago
## Code of Conduct
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
9 years ago
9 years ago
## License
9 years ago
[MIT](https://github.com/Microsoft/monaco-languages/blob/master/LICENSE.md)