AsciiDoc Package for Sublime Text2
JavaScript
#10 Compare This branch is 11 commits ahead, 11 commits behind mrchief:master.
Latest commit 2f1367a Jan 21, 2016 @FichteFoll FichteFoll Merge pull request #11 from SublimeText/raw-spelling-fix
Fix spelling in raw scopes
Failed to load latest commit information.
Anchor.sublime-snippet Corrected tab trigger settings Dec 11, 2011
AsciiDoc.tmLanguage Fix spelling in raw scopes Jan 21, 2016
Bold.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Comment Block.sublime-snippet Added language and snippets Dec 10, 2011
Default (Linux).sublime-keymap Added more keyboard shortcuts, removed conflicting keyboard shortcut … Jun 1, 2012
Default (OSX).sublime-keymap Correct mapping for OSX shortcuts Jun 4, 2013
Default (Windows).sublime-keymap Added more keyboard shortcuts, removed conflicting keyboard shortcut … Jun 1, 2012
Example Block.sublime-snippet Added language and snippets Dec 11, 2011
Heading 0 (one-liner).sublime-snippet Added language and snippets Dec 11, 2011
Heading 0.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Heading 1 (one-liner).sublime-snippet Added language and snippets Dec 11, 2011
Heading 1.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Heading 2 (one-liner).sublime-snippet Added language and snippets Dec 11, 2011
Heading 2.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Heading 3 (one-liner).sublime-snippet Added language and snippets Dec 11, 2011
Heading 3.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Heading 4 (one-liner).sublime-snippet Added language and snippets Dec 11, 2011
Heading 4.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Italic.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Listing Block.sublime-snippet Added language and snippets Dec 11, 2011
Literal Block.sublime-snippet Added language and snippets Dec 11, 2011
Passthrough Block.sublime-snippet Added language and snippets Dec 11, 2011
Quote Block.sublime-snippet Added language and snippets Dec 11, 2011
Quoted.sublime-snippet Corrected tab trigger settings Dec 11, 2011
ReadMe.md Update ReadMe.md Jun 19, 2014
Sidebar Block.sublime-snippet Added language and snippets Dec 11, 2011
Subscript.sublime-snippet Added language and snippets Dec 11, 2011
Superscript.sublime-snippet Corrected tab trigger settings Dec 11, 2011
Table.sublime-snippet Added language and snippets Dec 11, 2011

ReadMe.md

AsciiDoc Package for Sublime Text 2

This is an AsciiDoc package for Sublime Text 2 editor.

It adds syntax highlighting and snippets for AsciiDoc language to Sublime Text 2 editor.

My work is based on the Christian Zuckschwerdt's AsciiDoc TextMate bundle.

Sublime Text 2 is compatible with Textmate editor for OS X snippets, preferences and languages file. However, even though it can recognize the Textmate snippets, some features such as tab completion, shortcut commands do not work out of the box.

My work is to overcome these limitations.

All the files provided here are tested in Windows 7 and OS X Lion.

Installation

To install the package, follow these steps:

  • Download the zip containing src files.
  • Extract the files to AsciiDoc folder (create this folder if not present already) under:
    • Windows: %APPDATA%\Sublime Text 2\Packages\
    • OS X: ~/Library/Application Support/Sublime Text 2/Packages
    • Linux: ~/.config/sublime-text-2/Packages
    • Portable Installation: Sublime Text 2/Data
  • Close all instances of Sublime Text 2 editor and relaunch the editor.

If successful, you should see AsciiDoc entry under View > Syntax and under Tools > Snippets.

Note: Snippets may take few seconds to load under Windows.

Usage

  • Create a new file, save it as <filename>.asc
  • Start typing AsciiDoc!

Snippets

Snippets can be inserted anywhere by using the menu command Tools > Snippets > AsciiDoc or by typing two initial characters and hitting tab to complete. Few tab completion examples are:

  • Comments (type // TAB)
  • Headings (type h1 TAB to h4 TAB for one-liner versions)
  • Table generation (type |= TAB)
  • Tab expansion for blocks (type == TAB)
  • Sidebar block (type ** TAB)

Keyboard Shortcuts

Basic support for some handy shortcuts are now available:

  • Bold selection: Select some text and then press ctrl+b
  • _Italic_ize selection: Select some text and then press ctrl+i
  • Mark selection as Code literal: Select some text and then press ctrl+k, ctrl+k
  • Mark selection as filename: Select some text and then press ctrl+k, ctrl+f

Note: ctrl+b overrides the standard key binding of Tools > Build System. If this bothers you, you can edit the .sublime-keymap files (based on your OS) under Packages\AsciiDoc folder.

Time permitting, I'll add more shortcuts but meanwhile if you come upon something useful, feel free to submit a patch!

Enhancements

Following are planned enhancements for the package:

  • Add keyboard shortcuts for various commands such bold text, italics, blocks etc.
  • Adding Build system to preview as HTML or PDF.

Your suggestions are welcome.

Author & Credits

Created by Hrusikesh Panda. Copy left or right, as you wish.

Credit goes to Christian Zuckschwerdt for his original work on AsciiDoc TextMate bundle.