├── .gitignore
├── .spmignore
├── CONTRIBUTING.md
├── Gruntfile.js
├── Makefile
├── README.md
├── component.json
├── docs
├── index.html
├── markdown.html
├── markdown.md
├── marked.js
└── yue.css
├── editor.css
├── package.json
├── paper.css
├── src
├── editor.js
└── intro.js
└── vendor
├── codemirror.js
├── continuelist.js
├── icomoon
├── fonts
│ ├── icomoon.dev.svg
│ ├── icomoon.eot
│ ├── icomoon.svg
│ ├── icomoon.ttf
│ └── icomoon.woff
├── index.html
├── license.txt
├── lte-ie7.js
└── style.css
├── markdown.js
└── xml.js
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | node_modules
3 | dist
4 | npm-debug.log
5 | tmp
6 | build
7 | dist
8 |
--------------------------------------------------------------------------------
/.spmignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | dist
3 | npm-debug.log
4 | tmp
5 | build
6 | dist
7 | src
8 | icomoon
9 | codemirror
10 | docs
11 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | There are more than one way to contribute, and I will appreciate any way you choose.
4 |
5 | - tell your friends about lepture/editor, let lepture/editor to be known
6 | - discuss editor, and submit bugs with github issues
7 | - send patch with github pull request
8 |
9 | English and Chinsese issuses are acceptable, but English is prefered.
10 |
11 | Pull request and git commit message only accept English, if your commit message is in other language, it will be rejected.
12 |
13 |
14 | ## Codebase
15 |
16 | The codebase of editor is highly linted, as a way to keep all code written in a particular style for readability. You should follow the code style.
17 |
18 | A little hint to make things simple:
19 |
20 | - when you cloned this repo, run ``npm install``
21 | - check the code style with ``grunt jshint``
22 |
23 | ## Grunt
24 |
25 | If you haven't installed `grunt` yet, grab the command line:
26 |
27 | ```
28 | $ npm install grunt-cli -g
29 | ```
30 |
31 | Create a livereload server for your development:
32 |
33 | ```
34 | $ grunt server
35 | ```
36 |
37 | And open your browser at `http://localhost:8000`.
38 |
39 | The source code is in `src`.
40 |
41 | ## Git Help
42 |
43 | Something you should know about git.
44 |
45 | - don't add any code on the master branch, create a new one
46 | - don't add too many code in one pull request, you can't add too many features in one pull request
47 |
48 | Hint of git:
49 |
50 | ```
51 | $ git branch [featurename]
52 | $ git checkout [featurename]
53 | ```
54 |
--------------------------------------------------------------------------------
/Gruntfile.js:
--------------------------------------------------------------------------------
1 | var path = require('path');
2 |
3 | module.exports = function(grunt) {
4 | var pkg = require('./package.json');
5 |
6 | grunt.initConfig({
7 | pkg: pkg,
8 | connect: {
9 | livereload: {
10 | options: {
11 | port: 8000,
12 | middleware: function(connect) {
13 | return [
14 | require('connect-livereload')(),
15 | connect.static(path.resolve('build')),
16 | connect.directory(path.resolve('build'))
17 | ];
18 | }
19 | }
20 | },
21 | },
22 | watch: {
23 | editor: {
24 | files: ['*.css', 'src/*'],
25 | tasks: ['build'],
26 | options: {
27 | livereload: true
28 | }
29 | }
30 | },
31 | transport: {
32 | component: {
33 | options: {
34 | dest: 'index.js',
35 | header: '',
36 | footer: 'module.exports = Editor'
37 | }
38 | },
39 | window: {}
40 | }
41 | });
42 |
43 | grunt.registerTask('concat', function() {
44 | var data = grunt.file.read('vendor/codemirror.js');
45 | data = data.replace('window.CodeMirror', 'var CodeMirror');
46 | ['continuelist', 'xml', 'markdown'].forEach(function(name) {
47 | data += '\n' + grunt.file.read('vendor/' + name + '.js');
48 | });
49 | data += '\n' + grunt.file.read('src/intro.js');
50 | data += '\n' + grunt.file.read('src/editor.js');
51 | grunt.file.write('tmp/editor.js', data);
52 | });
53 |
54 | grunt.registerMultiTask('transport', function() {
55 | var options = this.options({
56 | src: 'tmp/editor.js',
57 | dest: 'build/editor.js',
58 | header: '(function(global) {',
59 | footer: 'global.Editor = Editor;\n})(this);'
60 | });
61 | var data = grunt.file.read(options.src);
62 | data = [options.header, data, options.footer].join('\n');
63 | grunt.file.write(options.dest, data);
64 | });
65 |
66 | grunt.registerTask('copy', function() {
67 | var dir = 'vendor/icomoon/fonts';
68 | grunt.file.recurse(dir, function(fpath) {
69 | var fname = path.relative(dir, fpath);
70 | grunt.file.copy(fpath, path.join('build', 'fonts', fname));
71 | });
72 | var data = grunt.file.read('vendor/icomoon/style.css');
73 | data += grunt.file.read('paper.css');
74 | data += grunt.file.read('editor.css');
75 | grunt.file.write('build/editor.css', data);
76 | grunt.file.copy('docs/index.html', 'build/index.html');
77 | grunt.file.copy('docs/markdown.md', 'build/markdown.md');
78 | grunt.file.copy('docs/markdown.html', 'build/markdown.html');
79 | grunt.file.copy('docs/yue.css', 'build/yue.css');
80 | grunt.file.copy('docs/marked.js', 'build/marked.js');
81 | });
82 |
83 | grunt.loadNpmTasks('grunt-contrib-connect');
84 | grunt.loadNpmTasks('grunt-contrib-watch');
85 |
86 | grunt.registerTask('build', ['concat', 'transport:window', 'copy']);
87 | grunt.registerTask('server', ['build', 'connect', 'watch']);
88 | grunt.registerTask('default', ['server']);
89 | };
90 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 |
2 | build: components index.js editor.css
3 | @component build --dev
4 |
5 | components: component.json
6 | @component install --dev
7 |
8 | clean:
9 | rm -fr build components template.js
10 |
11 | publish:
12 | @ghp-import build -p
13 |
14 | .PHONY: clean
15 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | ## Editor
2 |
3 | > A markdown editor you really want.
4 |
5 | ## Sponsors
6 |
7 | Editor is sponsored by [Typlog](https://typlog.com/).
8 |
9 | ## Overview
10 |
11 | Editor is not a WYSIWYG editor, it is a plain text markdown editor. Thanks for the great project [codemirror](http://codemirror.net/), without which editor can never be created.
12 |
13 | ## Basic Usage
14 |
15 | The easiest way to use Editor is to simply load the script and stylesheet:
16 |
17 | ```html
18 |
19 |
20 |
21 | ```
22 |
23 | You can also use [jsdelivr CDN](http://www.jsdelivr.com/#!editor):
24 |
25 | ```html
26 |
27 |
28 |
29 | ```
30 |
31 | Having done this, an editor instance can be created:
32 |
33 | ```js
34 | var editor = new Editor();
35 | editor.render();
36 | ```
37 |
38 | The editor will take the position of the first `
41 |
42 |
43 |
44 |
54 |
55 |