Netsyms/easy-markdown-editor
2
0
Fork 0
mirror of https://github.com/Ionaru/easy-markdown-editor synced 2025-07-25 10:54:28 -06:00
Code Issues Releases Wiki Activity

Merge branch 'master' into dropdown

Browse Source
This commit is contained in:
Jeroen Akkerman 2020-03-06 00:52:20 +01:00
commit 8c01edd7cd
8 changed files with 60 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -8,9 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added ### Added
- `inputStyle` and `nativeSpellcheck` options to manage the native language of the browser (Thanks to [@firm1], [#143]). - `inputStyle` and `nativeSpellcheck` options to manage the native language of the browser (Thanks to [@firm1], [#143]).
- Group buttons in drop-down lists by adding a sub-option `children` for the items in the toolbar (Thanks to [@firm1], [#141]). - Group buttons in drop-down lists by adding a sub-option `children` for the items in the toolbar (Thanks to [@firm1], [#141]).
- `sanitizerFunction` option to allow custom HTML sanitizing in the markdown preview (Thanks to [@adamb70], [#147]).
### Changed ### Changed
- Delay before assuming that submit of the form as failed is `autosave.submit_delay` instead of `autosave.delay` (Thanks to [@Situphen], [#139]). - Delay before assuming that submit of the form as failed is `autosave.submit_delay` instead of `autosave.delay` (Thanks to [@Situphen], [#139]).
- Add `watch` task for gulp.
## [2.9.0] - 2020-01-13 ## [2.9.0] - 2020-01-13
### Added ### Added
@ -147,7 +148,7 @@ Project forked from [SimpleMDE](https://github.com/sparksuite/simplemde-markdown
[#9]: https://github.com/Ionaru/easy-markdown-editor/issues/9 [#9]: https://github.com/Ionaru/easy-markdown-editor/issues/9
<!-- Linked PRs --> <!-- Linked PRs -->
[#143]: https://github.com/Ionaru/easy-markdown-editor/pull/132 [#143]: https://github.com/Ionaru/easy-markdown-editor/pull/143
[#139]: https://github.com/Ionaru/easy-markdown-editor/pull/139 [#139]: https://github.com/Ionaru/easy-markdown-editor/pull/139
[#132]: https://github.com/Ionaru/easy-markdown-editor/pull/132 [#132]: https://github.com/Ionaru/easy-markdown-editor/pull/132
[#123]: https://github.com/Ionaru/easy-markdown-editor/pull/123 [#123]: https://github.com/Ionaru/easy-markdown-editor/pull/123

5
README.md
View File

@ -178,6 +178,7 @@ easyMDE.value('New input for **EasyMDE**');
- **hljs**: An injectible instance of [highlight.js](https://github.com/isagalaev/highlight.js). If you don't want to rely on the global namespace (`window.hljs`), you can provide an instance here. Defaults to `undefined`. - **hljs**: An injectible instance of [highlight.js](https://github.com/isagalaev/highlight.js). If you don't want to rely on the global namespace (`window.hljs`), you can provide an instance here. Defaults to `undefined`.
- **markedOptions**: Set the internal Markdown renderer's [options](https://marked.js.org/#/USING_ADVANCED.md#options). Other `renderingConfig` options will take precedence. - **markedOptions**: Set the internal Markdown renderer's [options](https://marked.js.org/#/USING_ADVANCED.md#options). Other `renderingConfig` options will take precedence.
- **singleLineBreaks**: If set to `false`, disable parsing GFM single line breaks. Defaults to `true`. - **singleLineBreaks**: If set to `false`, disable parsing GFM single line breaks. Defaults to `true`.
- **sanitizerFunction**: Custom function for sanitizing the HTML output of markdown renderer.
- **shortcuts**: Keyboard shortcuts associated with this instance. Defaults to the [array of shortcuts](#keyboard-shortcuts). - **shortcuts**: Keyboard shortcuts associated with this instance. Defaults to the [array of shortcuts](#keyboard-shortcuts).
- **showIcons**: An array of icon names to show. Can be used to show specific icons hidden by default without completely customizing the toolbar. - **showIcons**: An array of icon names to show. Can be used to show specific icons hidden by default without completely customizing the toolbar.
- **spellChecker**: If set to `false`, disable the spell checker. Defaults to `true`. - **spellChecker**: If set to `false`, disable the spell checker. Defaults to `true`.
@ -251,6 +252,10 @@ var editor = new EasyMDE({
renderingConfig: { renderingConfig: {
singleLineBreaks: false, singleLineBreaks: false,
codeSyntaxHighlighting: true, codeSyntaxHighlighting: true,
sanitizerFunction: function(renderedHTML) {
// Using DOMPurify and only allowing <b> tags
return DOMPurify.sanitize(renderedHTML, {ALLOWED_TAGS: ['b']})
},
}, },
shortcuts: { shortcuts: {
drawTable: "Cmd-Alt-T" drawTable: "Cmd-Alt-T"

20
example/index.html Normal file
View File

@ -0,0 +1,20 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Example / Preview</title>
<link rel="stylesheet" href="../dist/easymde.min.css">
<script src="../dist/easymde.min.js"></script>
</head>
<body>
<textarea></textarea>
<script>
var easyMDE = new EasyMDE();
</script>
</body>
</html>

20
gulpfile.js
View File

@ -20,6 +20,13 @@ var banner = ['/**',
' */', ' */',
''].join('\n'); ''].join('\n');
var css_files = [
'./node_modules/codemirror/lib/codemirror.css',
'./src/css/*.css',
'./node_modules/codemirror-spell-checker/src/css/spell-checker.css',
];
function lint() { function lint() {
return gulp.src('./src/js/**/*.js') return gulp.src('./src/js/**/*.js')
.pipe(eslint()) .pipe(eslint())
@ -37,12 +44,6 @@ function scripts() {
} }
function styles() { function styles() {
var css_files = [
'./node_modules/codemirror/lib/codemirror.css',
'./src/css/*.css',
'./node_modules/codemirror-spell-checker/src/css/spell-checker.css',
];
return gulp.src(css_files) return gulp.src(css_files)
.pipe(concat('easymde.css')) .pipe(concat('easymde.css'))
.pipe(cleanCSS()) .pipe(cleanCSS())
@ -52,7 +53,14 @@ function styles() {
.pipe(gulp.dest('./dist/')); .pipe(gulp.dest('./dist/'));
} }
// Watch for file changes
function watch() {
gulp.watch('./src/js/**/*.js', scripts)
gulp.watch(css_files, styles)
}
var build = gulp.parallel(gulp.series(lint, scripts), styles); var build = gulp.parallel(gulp.series(lint, scripts), styles);
gulp.task('default', build); gulp.task('default', build);
gulp.task('watch', gulp.series(build, watch));
gulp.task('lint', lint); gulp.task('lint', lint);

18
package-lock.json generated
View File

@ -25,9 +25,9 @@
} }
}, },
"@types/codemirror": { "@types/codemirror": {
"version": "0.0.82", "version": "0.0.85",
"resolved": "https://registry.npmjs.org/@types/codemirror/-/codemirror-0.0.82.tgz", "resolved": "https://registry.npmjs.org/@types/codemirror/-/codemirror-0.0.85.tgz",
"integrity": "sha512-EVlPrt1rB256CRTlhNCXXLYaN24n3qZNStM6dRWaV6sUYyJA1SC5hvDSCHEHDg1SB93X8TwAGWRjEVdmUWPHmQ==", "integrity": "sha512-ZAVyNzXAHu/mkvvZlq2IYPBjm4X3mEno27epXpBRXwWbX75zAAeGZfubXxft1kWNqBSI2f50kvuJTG+fRwHaNg==",
"dev": true, "dev": true,
"requires": { "requires": {
"@types/tern": "*" "@types/tern": "*"
@ -1035,9 +1035,9 @@
"dev": true "dev": true
}, },
"codemirror": { "codemirror": {
"version": "5.50.2", "version": "5.51.0",
"resolved": "https://registry.npmjs.org/codemirror/-/codemirror-5.50.2.tgz", "resolved": "https://registry.npmjs.org/codemirror/-/codemirror-5.51.0.tgz",
"integrity": "sha512-PPjUsC1oXSM86lunKrw609P1oM0Wu8z9rqzjbeyBYCcx44VL41aUpccdOf1PfAZtTONlmN3sT3p2etLNYa1OGg==" "integrity": "sha512-vyuYYRv3eXL0SCuZA4spRFlKNzQAewHcipRQCOKgRy7VNAvZxTKzbItdbCl4S5AgPZ5g3WkHp+ibWQwv9TLG7Q=="
}, },
"codemirror-spell-checker": { "codemirror-spell-checker": {
"version": "1.1.2", "version": "1.1.2",
@ -5907,9 +5907,9 @@
"dev": true "dev": true
}, },
"typescript": { "typescript": {
"version": "3.7.4", "version": "3.7.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.4.tgz", "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.5.tgz",
"integrity": "sha512-A25xv5XCtarLwXpcDNZzCGvW2D1S3/bACratYBx2sax8PefsFhlYmkQicKHvpYflFS8if4zne5zT5kpJ7pzuvw==", "integrity": "sha512-/P5lkRXkWHNAbcJIiHPfRoKqyd7bsyCma1hZNUGfn20qm64T6ZBlrzprymeu918H+mB/0rIg2gGK/BXkhhYgBw==",
"dev": true "dev": true
}, },
"typo-js": { "typo-js": {

6
package.json
View File

@ -19,12 +19,12 @@
"license": "MIT", "license": "MIT",
"author": "Jeroen Akkerman", "author": "Jeroen Akkerman",
"dependencies": { "dependencies": {
"codemirror": "^5.50.2", "codemirror": "^5.51.0",
"codemirror-spell-checker": "1.1.2", "codemirror-spell-checker": "1.1.2",
"marked": "^0.8.0" "marked": "^0.8.0"
}, },
"devDependencies": { "devDependencies": {
"@types/codemirror": "0.0.82", "@types/codemirror": "0.0.85",
"@types/marked": "^0.7.2", "@types/marked": "^0.7.2",
"browserify": "^16.5.0", "browserify": "^16.5.0",
"gulp": "^4.0.2", "gulp": "^4.0.2",
@ -35,7 +35,7 @@
"gulp-rename": "^2.0.0", "gulp-rename": "^2.0.0",
"gulp-terser": "^1.2.0", "gulp-terser": "^1.2.0",
"gulp-uglify": "^3.0.2", "gulp-uglify": "^3.0.2",
"typescript": "^3.7.4", "typescript": "^3.7.5",
"vinyl-buffer": "^1.0.0", "vinyl-buffer": "^1.0.0",
"vinyl-source-stream": "^2.0.0" "vinyl-source-stream": "^2.0.0"
}, },

5
src/js/easymde.js
View File

@ -1791,6 +1791,11 @@ EasyMDE.prototype.markdown = function (text) {
// Convert the markdown to HTML // Convert the markdown to HTML
var htmlText = marked(text); var htmlText = marked(text);
// Sanitize HTML
if (this.options.renderingConfig && typeof this.options.renderingConfig.sanitizerFunction === 'function') {
htmlText = this.options.renderingConfig.sanitizerFunction.call(this, htmlText);
}
// Edit the HTML anchors to add 'target="_blank"' by default. // Edit the HTML anchors to add 'target="_blank"' by default.
htmlText = addAnchorTargetBlank(htmlText); htmlText = addAnchorTargetBlank(htmlText);

1
types/easymde.d.ts vendored
View File

@ -58,6 +58,7 @@ declare namespace EasyMDE {
codeSyntaxHighlighting?: boolean; codeSyntaxHighlighting?: boolean;
hljs?: any; hljs?: any;
markedOptions?: marked.MarkedOptions; markedOptions?: marked.MarkedOptions;
sanitizerFunction?: (html: string) => string;
singleLineBreaks?: boolean; singleLineBreaks?: boolean;
} }