init.lua

-- A Markdown module for the
-- [Textadept](http://foicica.com/textadept/) editor with some short cuts and
-- snippets for writing
-- [Markdown](http://daringfireball.net/projects/markdown/).<br>
--
-- Installation:<br>
-- Download an
-- [archived](https://github.com/rgieseke/ta-markdown/archives/master)
-- version or clone the git repository into your `.textadept` directory:
--
--     cd ~/.textadept/modules
--     git clone https://github.com/rgieseke/ta-markdown.git \
--         markdown
--
-- The [source](https://github.com/rgieseke/ta-markdown) is on GitHub,
-- released under the
-- [MIT license](http://www.opensource.org/licenses/mit-license.php).

local M = {}


-- ## Settings

-- Local variables.
local editing, run = textadept.editing
-- Blockquotes.
editing.comment_string.markdown = '> '

-- Sets default buffer properties for Markdown files.
events.connect(events.LEXER_LOADED, function(lang)
  if lang == 'markdown' then
    buffer.tab_width = 4
    -- Auto-matching chars.<br>
    -- Match `<` for embedded HTML, don't match `'`.
    if textadept.editing.auto_pairs then
      editing.auto_pairs[60] = '>'
    end
  else
    if textadept.editing.auto_pairs then
      editing.auto_pairs[60] = nil
    end
  end
end)


-- ## Commands

-- Underlines the current line.<br>
-- Parameter:<br>
-- _char_: "=" or "-".
function M.underline(char)
  local b = buffer
  b:begin_undo_action()
  b:line_end()
  caret = b.current_pos
  b:home()
  start = b.current_pos
  b:line_end()
  b:new_line()
  b:add_text(string.rep(char, caret - start))
  b:new_line()
  b:end_undo_action()
end

-- Sets the current line's header level.<br>
-- Parameter:<br>
-- _level_: 1 - 6
function M.header(level)
  local b = buffer
  local pos = b.current_pos
  b:begin_undo_action()
  editing.select_line()
  sel = b:get_sel_text()
  sel, count = sel:gsub('#+', string.rep('#', level))
  if count == 0 then
    b:home()
    b:add_text(string.rep('#', level)..' ')
    b:line_end()
  else
    b:replace_sel(sel)
    b:line_end()
  end
  b:end_undo_action()
end

-- Remove header symbols.
function M.remove_header()
  local b = buffer
  local pos = b.current_pos
  b:begin_undo_action()
  editing.select_line()
  sel = b:get_sel_text()
  sel = sel:gsub('#+ ', '')
  b:replace_sel(sel)
  b:line_end()
  b:end_undo_action()
end

-- Display word and char count in status bar.
function word_count()
  local buffer = buffer
  local text, length = buffer:get_text(buffer.get_length)
  if #text > 0 then text = text.." " end
  text = string.gsub(text, "^%s+", "")
  seps = string.gmatch(text, "%s+")
  local count = 0
  for i in seps do
    count = count + 1
  end
  status = 'Words: %d - Chars: %d'
  ui.statusbar_text = status:format(count, buffer.length)
end


-- ## Key Commands

-- Markdown-specific key commands.
keys.markdown = {
  [not OSX and not CURSES and 'ctrl+l' or 'cmd+l'] = {
    -- Open this module for editing: `Alt/⌘-L` `M`
    m = function() io.open_file(_USERHOME..'/modules/markdown/init.lua') end,
    --  Show char and word count: `Alt/⌘-L` `I`
    i = function() word_count() end,
  },
  -- Underline current line: `Alt/⌘ ='
  [OSX and 'cmd+=' or 'alt+='] = function() M.underline '=' end,
  -- Underline current line: `Alt/⌘ -`
  [OSX and 'cmd+-' or 'alt+-'] = function() M.underline '-' end,
  -- Change header level: `Alt/⌘-0 … 6`
  [OSX and 'cmd+0' or 'alt+0'] = function() M.remove_header() end,
  [OSX and 'cmd+1' or 'alt+1'] = function() M.header(1) end,
  [OSX and 'cmd+2' or 'alt+2'] = function() M.header(2) end,
  [OSX and 'cmd+3' or 'alt+3'] = function() M.header(3) end,
  [OSX and 'cmd+4' or 'alt+4'] = function() M.header(4) end,
  [OSX and 'cmd+5' or 'alt+5'] = function() M.header(5) end,
  [OSX and 'cmd+6' or 'alt+6'] = function() M.header(6) end,
  -- Enclose selected text or previous word:<br>
  -- `Alt/⌘ *`, `Alt/⌘ _`, ``Ctrl Alt/⌘ ` ``
  [OSX and 'cmd+*' or 'alt+*'] = function() editing.enclose("*", "*") end,
  [OSX and 'cmd+_' or 'alt+_'] = function() editing.enclose("_", "_") end,
  [OSX and 'ctrl+cmd`' or 'ctrl+alt`'] = function() editing.enclose("`", "`") end,
}

-- ## Snippets.

-- Markdown-specific snippets.
snippets.markdown = {
  -- Headers.
  ['1'] = '# ',
  ['2'] = '## ',
  ['3'] = '### ',
  ['4'] = '#### ',
  ['5'] = '##### ',
  ['6'] = '###### ',
  -- Link.
  l = '[%1(Link)](%2(http://example.net/))',
  -- Clickable link.
  cl = '<%1(http://example.com/)>',
  --  Reference-style link.
  rl = '[%1(example)][%2(ref)]',
  id = '[%1(ref)]: %2(http://example.com/)',
  -- Code.
  c = '`%0`',
  -- Image.
  i = '![%1(Alt text)](%2(/path/to/img.jpg "Optional title"))',
}

return M