maxmustermann/vscode
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Ship README.md with monaco-editor-core

Browse source
This commit is contained in:
Alex Dima 2016-06-09 11:20:03 +02:00
parent 8ad5ab52b7
commit 07607511db
2 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
build/gulpfile.editor.js
View file

@ -11,6 +11,7 @@ var util = require('./lib/util');
var common = require('./gulpfile.common');
var es = require('event-stream');
var fs = require('fs');
var File = require('vinyl');
var root = path.dirname(__dirname);
var sha1 = util.getVersion(root);
@ -104,6 +105,17 @@ gulp.task('editor-distro', ['clean-editor-distro', 'minify-editor', 'optimize-ed
}))
.pipe(gulp.dest('out-monaco-editor-core')),
// README.md
gulp.src('build/monaco/README-npm.md')
.pipe(es.through(function(data) {
this.emit('data', new File({
path: data.path.replace(/README-npm\.md/, 'README.md'),
base: data.base,
contents: data.contents
}));
}))
.pipe(gulp.dest('out-monaco-editor-core')),
// dev folder
es.merge(
gulp.src('out-editor/**/*')

14
build/monaco/README-npm.md Normal file
View file

@ -0,0 +1,14 @@
# monaco-editor-core
> This npm module is a building block for the [monaco-editor](https://www.npmjs.com/package/monaco-editor)
npm module and unless you are doing something special (e.g. authoring a monaco editor language that can be shipped
and consumed independently), it is best to consume the [monaco-editor](https://www.npmjs.com/package/monaco-editor) module
that contains this module and adds languages supports.
The Monaco Editor is the code editor that powers [VS Code](https://github.com/Microsoft/vscode),
a good page describing the code editor's features is [here](https://code.visualstudio.com/docs/editor/editingevolved).
This npm module contains the core editor functionality, as it comes from the [vscode repository](https://github.com/Microsoft/vscode).
## License
[MIT](https://github.com/Microsoft/vscode/blob/master/LICENSE.txt)