✒️ Make Atom a better Markdown/AsciiDoc editor for writers and bloggers
Branch: master
Clone or download
Latest commit 28e00ec Feb 17, 2019

README.md

Markdown-Writer for Atom

Apm Version Apm Downloads Travis Build Status Appveyor Build status Reviewed by Hound

Adds tons of features to make Atom a better Markdown/AsciiDoc editor!

Works great with static blogging as well. Try it with Jekyll, Octopress, Hexo or any of your favorite static blog engines.

Insert Image

More GIFs Here: Create New Post, Insert Reference Link, Remove Reference Link.

Table of Contents (click to expand)

Features

Blogging

  • Create new draft with front matters (setup^).
  • Create new post with front matters (setup^).
  • Publish draft moves a draft to post's directory with front matters (date, published) auto updated.
  • Manage tags and categories in front matters (setup*).
  • Custom fields in front matters (setup*).
  • Project/Blog specific settings supported (setup+).

General

  • Table of contents (TOC) (markdown-writer:insert-toc).
    • Update table of content (markdown-writer:update-toc).
    • Following options (global/inline) are supported:
      • depthFrom, depthTo: range of headings to be displayed.
      • insertAnchor: insert TOC with anchor link.
  • Insert link (shift-cmd-k) and save links for next time.
    • Insert inline link.
    • Insert reference link with title. Use - in title field to create an empty title reference link.
    • Remove link (and its reference) after URL is deleted.
    • Search and insert published posts by title in blog (setup*).
  • Insert footnote (markdown-writer:insert-footnote), and edit footnote labels.
  • Insert image from file or clipboard (shift-cmd-i) with preview.
    • Save or copy the image to your blog's images directory (customize).
  • Insert table (markdown-writer:insert-table) and jump to next table cell (cmd-j cmd-t).
  • Format table (markdown-writer:format-table) with customizable table alignments.
  • Continue lists and table rows when press enter (customize).
  • Correct ordered list numbers (markdown-writer:correct-order-list-numbers).
  • Toggle headings: ctrl-alt-[1-5] to switch among H1 to H5.
  • Toggle text styles (customize):
    • code (cmd-')
    • bold (cmd-b)
    • italic (cmd-i)
    • strike through (cmd-h)
    • '''code block''' (shift-cmd-")
    • <kbd>key</kbd> (cmd + k)
    • - unordered list (shift-cmd-U)
    • 0. ordered list (shift-cmd-O)
    • > blockquote (shift-cmd->)
    • - [ ] task list (markdown-writer:toggle-task)
  • Jumping commands:
    • Jump to previous heading (cmd-j cmd-p)
    • Jump to next heading (cmd-j cmd-n)
    • Jump to next table cell (cmd-j cmd-t)
    • Jump to reference marker/definition (cmd-j cmd-d)
  • Folding commands:
    • Fold all headings (markdown-writer:fold-headings)
    • Fold and focus current heading (markdown-writer:focus-current-heading)
    • Fold all inline links (markdown-writer:fold-links)
  • Open links:
    • Open link under cursor in browser (markdown-writer:open-link-in-browser).
    • Open link under cursor in editor (markdown-writer:open-link-in-file).
  • Markdown cheat sheet (markdown-writer:open-cheat-sheet).

CriticMarkup

Following CriticMarkup commands are supported:

  • Addition {++ ++} (markdown-writer:toggle-addition-text)
  • Deletion {-- --} (markdown-writer:toggle-deletion-text)
  • Substitution {~~ ~> ~~} (markdown-writer:toggle-substitution-text)
  • Comment {>> <<} (markdown-writer:toggle-comment-text)
  • Highlight {== ==}{>> <<} (markdown-writer:toggle-highlight-text)

AsciiDoc

AsciiDoc is supported with language-asciidoc installed.

Plugins

Toolbar for Markdown Writer is available at tool-bar-markdown-writer.

Installation

  • In Atom, go to Settings (cmd-,) -> Install -> Search Markdown Writer.
  • Or, run apm install markdown-writer.

After installation, you can find and trigger any feature through:

  • Open Command Palette (shift-cmd-P), enter Markdown Writer and find all the commands
  • Or, go to menu Packages -> Markdown Writer.

Setup

Execute command Markdown Writer: Create Default keymaps to add the recommended keymaps to your configs. You can modify them based on your needs (wiki).

  • Enter, Tab, Shift-Tab are registered by default. You can disable them in Package's Settings > Keybindings.

Configure your Package's Settings. Menu: File -> Settings (cmd-,) -> Packages -> Markdown-Writer -> Settings.

  • To manage tags/categories in front matter, follow this setup.
  • To manage all/advanced configurations (e.g. project specific settings, change italic text styles), follow this setup.

Contributing

Your contributions are really appreciated. You can follow CONTRIBUTING guide to get everything started.

Project