lv-code / md-writer

✒️ Make Atom a better Markdown/AsciiDoc editor for writers and bloggers

Markdown-Writer for Atom

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.

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

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

• Continue lists or table rows when you press enter (customize).
  • Correct ordered list numbers (markdown-writer:correct-order-list-numbers).
• Insert link (shift-cmd-k) and automatically link to the text 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 published posts by title in your blog.
• Insert footnote (markdown-writer:insert-footnote), and edit footnote labels.
• Insert image from file or clipboard (shift-cmd-i), preview image and able to copy image to your blog's images directory.
• Insert table (markdown-writer:insert-table), and quick jump to next table cell (cmd-j cmd-t).
• Format table (markdown-writer:format-table) with table alignments.
• Toggle headings: ctrl-alt-[1-5] to switch among H1 to H5.
• Toggle text styles (customize styles):
  • 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 inline links (markdown-writer:fold-links).
• Open a link under cursor in browser (markdown-writer:open-link-in-browser), and this works on reference links.
• Markdown cheat sheet (markdown-writer:open-cheat-sheet).
• Toolbar for Markdown Writer is available at tool-bar-markdown-writer.
• CriticMarkup support:
  • 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 support with language-asciidoc.

You can find and trigger all features through:

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

Installation

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

If you see errors after this plugin updates, please restart Atom so that it reloads the updated code.

Setup

Execute command Markdown Writer: Create Default keymaps to add recommended keymaps to your configs, and start modifying 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

• View CHANGELOG 📔
• Bugs, suggestions or feature requests, open an issue
• Star GitHub repo and Atom package to support this project 👍
• License in MIT 🔓
• Shipped by Zhuochun ☀️ and contributors 👏