https://github.com/zhuochun/md-writer

✒️ Make Atom a better Markdown/AsciiDoc editor for writers and bloggers
https://github.com/zhuochun/md-writer

asciidoc atom atom-package atom-plugin coffeescript markdown markdown-writer

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/zhuochun/md-writer
Owner: zhuochun
License: mit
Archived: true
Created: 2014-07-25T11:59:09.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2024-02-27T00:06:01.000Z (about 1 year ago)
Last Synced: 2024-05-01T20:34:17.713Z (about 1 year ago)
Topics: asciidoc, atom, atom-package, atom-plugin, coffeescript, markdown, markdown-writer
Language: CoffeeScript
Homepage: https://atom.io/packages/markdown-writer
Size: 778 KB
Stars: 341
Watchers: 13
Forks: 46
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Markdown-Writer for Atom

[![Apm Version](https://img.shields.io/apm/v/markdown-writer.svg)](https://atom.io/packages/markdown-writer)

[![Apm Downloads](https://img.shields.io/apm/dm/markdown-writer.svg)](https://atom.io/packages/markdown-writer)

[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)

Adds tons of features to make [Atom](https://atom.io/) a better Markdown/AsciiDoc editor!

Works great with static blogging as well. Try it with [Jekyll](http://jekyllrb.com/), [Octopress](http://octopress.org/), [Hexo](http://hexo.io/) or any of your favorite static blog engines.

![Insert Image](http://i.imgur.com/s9ekMns.gif)

More GIFs Here: [Create New Post](http://i.imgur.com/BwntxhB.gif), [Insert Reference Link](http://i.imgur.com/L67TqyF.gif), [Remove Reference Link](http://i.imgur.com/TglzeJV.gif).

  Table of Contents (click to expand)

- [Features](#features)

  - [Blogging](#blogging)

  - [General](#general)

  - [CriticMarkup](#criticmarkup)

  - [AsciiDoc](#asciidoc)

  - [Plugins](#plugins)

- [Installation](#installation)

- [Setup](#setup)

- [Contributing](#contributing)

- [Project](#project)

## Features

### Blogging

- **Create new draft** with front matters ([setup^][ca8870d7]).

- **Create new post** with front matters ([setup^][ca8870d7]).

- **Publish draft** moves a draft to post's directory with front matters (`date`, `published`) auto updated.

- **Manage tags and categories** in front matters ([setup*][9be76601]).

- **Custom fields** in front matters ([setup*][9be76601]).

- **Project/Blog specific settings** supported ([setup+][1561ed4c]).

[ca8870d7]: https://github.com/zhuochun/md-writer/wiki/Quick-Start "Markdown-Writer Setup Guide"

[9be76601]: https://github.com/zhuochun/md-writer/wiki/Settings-for-Front-Matters "Setup Tags/Categories/Posts"

[1561ed4c]: https://github.com/zhuochun/md-writer/wiki/Settings#project-specific-settings "Project Specific Settings"

### 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*][9be76601]).

- **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][e6198daa]).

- **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][adaa9527]).

- **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][7ddaeaf4]):

  - `code` (`cmd-'`)

  - **bold** (`cmd-b`)

  - _italic_ (`cmd-i`)

  - ~~strike through~~ (`cmd-h`)

  - `'''code block'''` (`shift-cmd-"`)

  - `key` (`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`).

[adaa9527]: https://github.com/zhuochun/md-writer/wiki/Settings#use-different-unordered-list-styles "Customizations"

[e6198daa]: https://github.com/zhuochun/md-writer/wiki/Settings#change-image-directory "Change Image Directory"

### CriticMarkup

Following [CriticMarkup][f99bc01e] 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`)

[f99bc01e]: http://criticmarkup.com/users-guide.php "CriticMarkup"

### AsciiDoc

[AsciiDoc][0e2299b8] is supported with [language-asciidoc][2f0cb1f9] installed.

[0e2299b8]: https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ "AsciiDoc Quick Reference"

[2f0cb1f9]: https://atom.io/packages/language-asciidoc "AsciiDoc Language Package for Atom"

### Plugins

**Toolbar for Markdown Writer** is available at [tool-bar-markdown-writer][82a2aced].

[82a2aced]: https://atom.io/packages/tool-bar-markdown-writer "Toobar for 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][31ebd53f]).

- `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][35eb9cc2].

- To **manage all/advanced configurations (e.g. project specific settings, change italic text styles)**, follow this [setup][7ddaeaf4].

[31ebd53f]: https://github.com/zhuochun/md-writer/wiki/Settings-for-Keymaps "Settings for Keymaps"

[3ecd2daa]: https://github.com/atom/settings-view/issues/356 "Viewing a package's settings should activate it"

[35eb9cc2]: https://github.com/zhuochun/md-writer/wiki/Settings-for-Front-Matters "Settings for Front Matters"

[7ddaeaf4]: https://github.com/zhuochun/md-writer/wiki/Settings "Settings"

## Contributing

Your contributions are really appreciated. You can follow [CONTRIBUTING](https://github.com/zhuochun/md-writer/blob/master/CONTRIBUTING.md) guide to get everything started.

## Project

- View [CHANGELOG][e45121fa] :notebook_with_decorative_cover:

- Bugs, suggestions or feature requests, [open an issue][e6ad7ed1] :octocat:

- Star [GitHub repo][e8960946] and [Atom package][91a1b9c2] to support this project :+1:

- License in [MIT][6a9a3773] :unlock:

- Shipped by [Zhuochun][41ae693b] :sunny: and [contributors][f303810e] :clap:

[e45121fa]: https://github.com/zhuochun/md-writer/blob/master/CHANGELOG.md

[e6ad7ed1]: https://github.com/zhuochun/md-writer/issues

[6a9a3773]: https://github.com/zhuochun/md-writer/blob/master/LICENSE.md

[41ae693b]: https://github.com/zhuochun

[f303810e]: https://github.com/zhuochun/md-writer/graphs/contributors

[e8960946]: https://github.com/zhuochun/md-writer

[91a1b9c2]: https://atom.io/packages/markdown-writer

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/zhuochun/md-writer

Awesome Lists containing this project

README