Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

dword

12.0.13 • Public • Published

Dword License NPM version Dependency Status

Web editor based on CodeMirror. Fork of edward.

dword

Features

  • Syntax highlighting based on extension of file for over 90 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 ~/.dword.json)

Install

npm i dword -g

NPM_INFO

Command line parameters

Usage: dword [filename]

Parameter Operation
-h, --help display help and exit
-v, --version output version information and exit

Hot keys

Key Operation
Ctrl + s save
Ctrl + f find
Ctrl + h replace
Ctrl + g go to line
Ctrl + e evaluate (JavaScript only supported)

API

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

Server

dword(options)

Middleware of dword. Options could be omitted.

const dword = require('dword');
const express = require('express');
const app = express();
 
app.use(dword({
    root: '/',              // default
    online: true,           // default
    diff: true,             // default
    zip: true,              // default
    dropbox: false,         // optional
    dropboxToken: 'token',  //  optional
}));
 
app.listen(31337);

dword.listen(socket)

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

const io = require('socket.io'),
const socket = io.listen(server);
 
dword.listen(socket, {
    prefixSocket: '/dword', // optional
    auth: (accept, reject) => (username, password) => { // optional
        accept();
    }
});

Client

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

Minimal html:

<div class="edit" data-name="js-edit"></div>
<script src="/dword/dword.js"></script>

Minimal css:

htmlbody.edit {
    height: 100%;
    margin: 0;
}

Minimal js:

dword('[data-name="js-edit"]', function(editor) {
    editor.setValue('hello dword');
    console.log('dword is ready');
});

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

Related

License

MIT

Install

npm i dword

DownloadsWeekly Downloads

582

Version

12.0.13

License

MIT

Unpacked Size

10.6 MB

Total Files

416

Last publish

Collaborators

  • avatar