alpha22jp / atomic-chrome

Edit text area on Chrome with Emacs using Atomic Chrome
392 stars 38 forks source link

Atomic Chrome for Emacs MELPA MELPA Stable

This is the Emacs version of Atomic Chrome which is an extension for Google Chrome browser that allows you to edit text areas of the browser in Emacs. It's similar to Edit with Emacs, but has some advantages as below with the help of websocket.

Since v2.0.0, Atomic Chrome for Emacs supports Ghost Text as browser extension, bringing compatibility with Firefox, too.

Screencast

Screencast

Requirements

Installation

For Chrome

Install the GhostText Chrome extension.

For Firefox

Install the GhostText Firefox extension.

For Emacs

Atomic Chrome for Emacs can be installed via MELPA as below.

M-x package-install [RET] atomic-chrome [RET]

Then add the following lines to your .emacs.

(require 'atomic-chrome)
(atomic-chrome-start-server)

Usage

  1. Start Emacs.
  2. Focus the text area you want to edit on the browser.
  3. Press Atomic Chrome button on the tool bar.
  4. Contet of the text area is opened in a new buffer of Emacs.
  5. Edit content on Emacs buffer.
  6. C-c C-c to finish editing, or the buffer killed if the browser closes the connection.

Customization

Set auto-update mode

Atomic Chrome for Emacs automatically reflects modifications to the browser by default as described above, but you can disable it by setting the variable below.

(setq atomic-chrome-enable-auto-update nil)

In this case, you can apply the modifications to the browser with C-c C-s

Set major mode for editing buffer

The default major mode of editing buffer is text-mode. You can change the major mode manually. If you want to use a different major mode as the default, set atomic-chrome-default-major-mode like below.

(setq atomic-chrome-default-major-mode 'markdown-mode)

Additionally, you can use atomic-chrome-url-major-mode-alist to choose the major mode for a specific website based on the page URL (or, with GhostText, URL hostname) like below.

(setq atomic-chrome-url-major-mode-alist
      '(("github\\.com" . gfm-mode)
        ("redmine" . textile-mode)))

This is an association list of regexp and major mode function. If the page URL matches to on of the regexp, the corresponding major mode is selected.

Select editing buffer style

You can select the style of opening the editing buffer by atomic-chrome-buffer-open-style like below.

(setq atomic-chrome-buffer-open-style 'frame)

Available values are the followings.

frame is available only when you are using Emacs on some window system.

If you select frame, you can also set the width and height of the frame with atomic-chrome-buffer-frame-width and atomic-chrome-buffer-frame-height. Their default values are 80 and 25.

Select available browser extension

By default, Atomic Chrome for Emacs accepts the connection request from both Atomic Chrome and Ghost Text. If you never use one of them, you can disable it by setting atomic-chrome-extension-type-list like below.

(setq atomic-chrome-extension-type-list '(atomic-chrome))

Set Server Port for Ghost Text

By default, Atomic Chrome for Emacs uses the default port 4001 for Ghost Text. If you need to set this to another port, you can do it by setting atomic-chrome-server-ghost-text-port like below.

(setq atomic-chrome-server-ghost-text-port 4002)

You may also need to update Ghost Text's port setting in Chrome Extensions page.

History

version 2.0.0 (2016-11-08)

version 1.0.1 (2016-11-06)

version 1.0.0 (2016-11-05)

version 0.1.0 (2016-10-23)