GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - cloudcmd/dword: Web editor based on CodeMirror

BranchesTags
Open more actions menu

Latest commit

 

History

1,063 Commits
1,063 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
assets
assets
 
 
bin
bin
 
 
client
client
 
 
codemirror
codemirror
 
 
css
css
 
 
img
img
 
 
json
json
 
 
modules
modules
 
 
server
server
 
 
.babelrc
.babelrc
 
 
.bowerrc
.bowerrc
 
 
.browserslistrc
.browserslistrc
 
 
.editorconfig
.editorconfig
 
 
.gitignore
.gitignore
 
 
.madrun.js
.madrun.js
 
 
.npmignore
.npmignore
 
 
.putout.json
.putout.json
 
 
ChangeLog
ChangeLog
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
bower.json
bower.json
 
 
eslint.config.js
eslint.config.js
 
 
package.json
package.json
 
 
webpack.config.codemirror.js
webpack.config.codemirror.js
 
 
webpack.config.js
webpack.config.js
 
 

Repository files navigation

Dword License NPM version

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.

import {dword} from 'dword';
import express from '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(31_337);

dword.listen(socket)

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

import {Server} from 'socket.io';
const socket = new Server(server);

dword.listen(socket, {
    // optional
    prefixSocket: '/dword',
    // optional
    auth: (accept, reject) => (username, password) => {
        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:

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

Minimal js:

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

Client API

dword(selector, callback)
  • selector: string
  • callback: EditorCallback

Initialize new instance

editor.setValue(value)
  • value: string

Set value to editor.

editor.getValue()
  • returns: string

Get value from editor.

Types
interface Editor {
    setValue: (value: string) => void;
    getValue: () => string;
}

type EditorCallback = (editor: Editor) => void;
type Dword = (selector: string, callback: EditorCallback) => void;

For more information you could always look around client/dword.js directory.

Related

  • Edward - web editor based on Ace.
  • Deepword - web editor based on Monaco.

License

MIT

About

Web editor based on CodeMirror

Topics

cloudcmdcodemirroreditorexpressjsmiddlewarenodejs

Resources

Readme
MIT license
Activity
Custom properties

Stars

39 stars

Watchers

2 watching

Forks

6 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.