Editmode Docs
Search…
Editmode For Sublime Text
Editmode for Sublime is a simple plugin which adds a keyboard shortcut to Sublime Text, allowing you to instantly convert content inside to chunks - it will take the text, send it to the Editmode API which returns an identifier, and replace it with a Editmode helper. Used in conjunction with Editmode.js, it allows one to very quickly convert an existing site to be fully editable by anyone in a short space of time.

Setup

1. Install the Editmode Plugin using Package Control

2. Set your authentication credentials

  • Every open directory in Sublime is seen as a project. In order to
    apply project specific settings, you need to save the existing open
    project: Project -> Save Project As
  • I would recommend saving the project file in the directory you would
    like the settings to apply to.
  • Once the .sublime-project file is saved, open it and add the correct
    path and chunks authentication token
1
{
2
"folders":[{ "path": "." }
3
],
4
"settings": {
5
"em_authentication_token": "YOURTOKENHERE",
6
"em_default_snippet_template" : "rails_erb",
7
"em_snippet_templates" : {
8
"rails_erb" : "<%= chunk('{label}','{identifier}') %>"
9
}
10
}
11
}
Copied!

3. Open the project

  • Close the current folder or files in Sublime, then hit "Project ->
    Open Project" and open the project you just saved.

Usage

Select a piece of text and hit cmd + shift + L in any open file inside a configured Sublime project.
  • The em_authentication_token identifies the Editmode project where
    the chunk will be saved to. You can find this in your Editmode
    account.
  • The plugin adds a keyboard shortcut (CMD+SHIFT+L) which you can use
    with any open file in a project where you have already specified
    your em_authentication_token.
  • Select the text you'd like to replace, then hit the keyboard
    shortcut, and Sublime will send the text to the configured Editmode
    project, and add a view helper in it's place. (Currently this uses
    the rails view helper syntax, but this can be configured in time as
    we add more rendering plugins).
Last modified 7mo ago
Copy link
Contents
Setup
Usage