Skip to content

Repository files navigation

Edward LicenseNPM version

Web editor used in Cloud Commander based on Ace.

Edward

Features

  • Syntax highlighting based on extension of file for over 110 languages.
  • Built-in emmet (for html files)
  • Drag n drop (drag file from desktop to editor).
  • Configurable options (json/edit.json could be overriden by ~/.edward.json)

Install

npm i edward -g

NPM_INFO

Command line parameters

Usage: edward [filename]

ParameterOperation
-h, --helpdisplay help and exit
-v, --versionoutput version information and exit

Hot keys

KeyOperation
Ctrl + ssave
Ctrl + ffind
Ctrl + hreplace
Ctrl + ggo to line
Ctrl + eevaluate (JavaScript only supported)

For more details see Ace keyboard shortcuts.

API

Edward could be used as middleware for express. For this purpuse API could be used.

Server

edward(options)

Middleware of edward. Options could be omitted.

import{edward}from'edward';importexpressfrom'express';constapp=express();app.use(edward({root: '/',// defaultonline: true,// defaultdiff: true,// defaultzip: true,// defaultdropbox: false,// optionaldropboxToken: 'token',// optional}));app.listen(31_337);

edward.listen(socket)

Could be used with socket.io to handle editor events with.

import{Server}from'socket.io';constsocket=newServer(server);edward.listen(socket,{root: '/',// optionalprefixSocket: '/edward',//optionalauth: (accept,reject)=>(username,password)=>{accept();},});

Client

Edward uses ace on client side, so API is similar. All you need is put minimal html, css, and js into your page.

Minimal html:

<divclass="edit" data-name="js-edit"></div><scriptsrc="/edward/edward.js"></script>

Minimal css:

html,body, .edit {
height:100%;
margin:0;
}

Minimal js:

edward('[data-name="js-edit"]',(editor)=>{editor.setValue('Hello edward!');});

For more information you could always look around into assets and bin directory.

Related

License

MIT

About

Web editor as express middleware

Topics

Resources

Stars

30 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages