Asciidoctor
AsciiDoc Package for SublimeText 3
Details
Installs
- Total 14K
- Win 5K
- Mac 5K
- Linux 3K
Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | Aug 20 | Aug 19 | Aug 18 | Aug 17 | Aug 16 | Aug 15 | Aug 14 | Aug 13 | Aug 12 | Aug 11 | Aug 10 | Aug 9 | Aug 8 | Aug 7 | Aug 6 | Aug 5 | Aug 4 | Aug 3 | Aug 2 | Aug 1 | Jul 31 | Jul 30 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 1 | 2 | 3 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 2 | 0 | 0 | 1 | 2 | 1 | 1 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 0 |
Mac | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 1 | 1 | 2 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 1 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 2 | 0 | 2 | 2 | 2 | 0 | 0 | 0 | 0 | 0 | 1 |
Linux | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 3 | 0 | 0 | 0 | 0 | 2 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 2 | 0 | 2 | 0 | 1 | 0 | 0 | 1 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
AsciiDoc Package for SublimeText 3
This package provides more complete and up-to-date syntax highlighting, snippets and other goodies for AsciiDoc editing in SublimeText 3.
TODO
Features
Keymaps
- Asterisks (strong), underscores (emphasis), backticks (monospaced), English quotation marks, and Czech quotation marks are autopaired and will wrap selected text.
- If you start an empty pair and hit backspace, both elements are deleted.
- If you start an empty asterisks pair and hit Space or Tab, the right element is deleted (because you probably wanted to start a list, not a strong text).
- At the end of a (un)ordered list item, pressing Enter will automatically insert the new list item “bullet.”
- Pressing Enter on the blank list item will remove it.
- Pressing Tab on the blank list item, or selected item(s), will increase nesting level and indent it.
- Pressing Shift Tab on the blank list item, or selected item(s), will decrease nesting level and unindent it.
- You can disable indentation of list items in your settings file.
- At the end of a callouts list item, pressing Enter will automatically insert the new list item with incremented number.
- Pressing Enter on the blank list item will remove it.
Snippets
Name | Trigger |
---|---|
Button | btn⇥ |
Comment Block | //⇥ |
Document Title | h0⇥ |
Example Block | |
Footnote Reference | fnr⇥ |
Footnote | fn⇥ |
Image | img⇥ |
Keyboard Shortcut | kbd⇥ |
Listing Block | –⇥ |
Passthrough Block | |
Quote Block | __⇥ |
Section Title 1–5 | h1⇥, …, h5⇥ |
Sidebar block | |
Table |
Others
- Displays document and section titles in the local symbol list (Ctrl R / Cmd R) and the global symbol list (Ctrl Shift R / Cmd Shift R).
- In the local symbol list, titles are nicely indented.
- In the global symbol list, titles will start with
=
, so you will know they belong to AsciiDoc files at a glance. Also they will be on top of the list because of the presedence of=
.
- Defines comment markers, so you can use default commands to comment and uncomment lines of text.
- Provides completions for attributes (built-in and locally defined) and cross references (local anchors and titles).
Installation
Note: If you have installed the AsciiDoc package, then you should remove it, or manually assign .adoc
extension to the Asciidoctor plugin.
Package Control
The easiest way to install this plugin is to use the Package Control plugin.
- Install Package Control, if you don’t have it already.
- Open the Command Palette (Ctrl Shift P, or Cmd Shift P), type “Install package” and hit Enter.
- Search for “Asciidoctor” and hit Enter.
Manually
You can also install this plugin manually from GitHub if you want, although Package Control automates just that.
- Go to your Packages subdirectory under the ST3’s data directory:
- OS X:
~/Library/Application\ Support/Sublime\ Text\ 3/Packages/
- Linux:
~/.config/sublime-text-3/Packages/
- Windows:
%APPDATA%\Sublime Text 3\Packages\
- OS X:
Clone this repository here into subdirectory Asciidoctor:
git clone https://github.com/asciidoctor/sublimetext-asciidoc.git Asciidoctor
Restart SublimeText.
Acknowledgement
The syntax definition is based on AsciiDoc-TextMate-2.tmbundle by Matt Neuburg.
Most of the commands, keymaps and some text in this readme are based on (or inspired by) MarkdownEditing package.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
License
This project is licensed under MIT License. For the full text of the license, see the LICENSE file.