{"id":25629190,"url":"https://github.com/zhuochun/md-writer","last_synced_at":"2026-06-10T09:30:24.546Z","repository":{"id":19030937,"uuid":"22255314","full_name":"zhuochun/md-writer","owner":"zhuochun","description":"✒️ Make Atom a better Markdown/AsciiDoc editor for writers and bloggers","archived":true,"fork":false,"pushed_at":"2024-02-27T00:06:01.000Z","size":797,"stargazers_count":341,"open_issues_count":15,"forks_count":46,"subscribers_count":13,"default_branch":"master","last_synced_at":"2024-05-01T20:34:17.713Z","etag":null,"topics":["asciidoc","atom","atom-package","atom-plugin","coffeescript","markdown","markdown-writer"],"latest_commit_sha":null,"homepage":"https://atom.io/packages/markdown-writer","language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhuochun.png","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","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"zhuochun","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2014-07-25T11:59:09.000Z","updated_at":"2024-04-02T02:50:46.000Z","dependencies_parsed_at":"2022-09-25T03:51:51.629Z","dependency_job_id":null,"html_url":"https://github.com/zhuochun/md-writer","commit_stats":null,"previous_names":[],"tags_count":99,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuochun%2Fmd-writer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuochun%2Fmd-writer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuochun%2Fmd-writer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuochun%2Fmd-writer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhuochun","download_url":"https://codeload.github.com/zhuochun/md-writer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240222477,"owners_count":19767460,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asciidoc","atom","atom-package","atom-plugin","coffeescript","markdown","markdown-writer"],"created_at":"2025-02-22T19:17:05.754Z","updated_at":"2026-06-10T09:30:22.844Z","avatar_url":"https://github.com/zhuochun.png","language":"CoffeeScript","funding_links":["https://github.com/sponsors/zhuochun"],"categories":["CoffeeScript"],"sub_categories":[],"readme":"# Markdown-Writer for Atom\n\n[![Apm Version](https://img.shields.io/apm/v/markdown-writer.svg)](https://atom.io/packages/markdown-writer)\n[![Apm Downloads](https://img.shields.io/apm/dm/markdown-writer.svg)](https://atom.io/packages/markdown-writer)\n[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)\n\nAdds tons of features to make [Atom](https://atom.io/) a better Markdown/AsciiDoc editor!\n\nWorks 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.\n\n![Insert Image](http://i.imgur.com/s9ekMns.gif)\n\nMore 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).\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eTable of Contents\u003c/strong\u003e (click to expand)\u003c/summary\u003e\n\n\u003c!-- TOC depthFrom:2 --\u003e\n\n- [Features](#features)\n  - [Blogging](#blogging)\n  - [General](#general)\n  - [CriticMarkup](#criticmarkup)\n  - [AsciiDoc](#asciidoc)\n  - [Plugins](#plugins)\n- [Installation](#installation)\n- [Setup](#setup)\n- [Contributing](#contributing)\n- [Project](#project)\n\n\u003c!-- /TOC --\u003e\n\u003c/details\u003e\n\n## Features\n\n### Blogging\n\n- **Create new draft** with front matters ([setup^][ca8870d7]).\n- **Create new post** with front matters ([setup^][ca8870d7]).\n- **Publish draft** moves a draft to post's directory with front matters (`date`, `published`) auto updated.\n- **Manage tags and categories** in front matters ([setup*][9be76601]).\n- **Custom fields** in front matters ([setup*][9be76601]).\n- **Project/Blog specific settings** supported ([setup+][1561ed4c]).\n\n[ca8870d7]: https://github.com/zhuochun/md-writer/wiki/Quick-Start \"Markdown-Writer Setup Guide\"\n[9be76601]: https://github.com/zhuochun/md-writer/wiki/Settings-for-Front-Matters \"Setup Tags/Categories/Posts\"\n[1561ed4c]: https://github.com/zhuochun/md-writer/wiki/Settings#project-specific-settings \"Project Specific Settings\"\n\n### General\n\n- **Table of contents (TOC)** (`markdown-writer:insert-toc`).\n  - Update table of content (`markdown-writer:update-toc`).\n  - Following options (global/inline) are supported:\n    - `depthFrom`, `depthTo`: range of headings to be displayed.\n    - `insertAnchor`: insert TOC with anchor link.\n- **Insert link** (`shift-cmd-k`) and save links for next time.\n  - Insert inline link.\n  - Insert reference link with title. _Use `-` in title field to create an empty title reference link._\n  - Remove link (and its reference) after URL is deleted.\n  - Search and insert published posts by title in blog ([setup*][9be76601]).\n- **Insert footnote** (`markdown-writer:insert-footnote`), and edit footnote labels.\n- **Insert image from file or clipboard** (`shift-cmd-i`) with preview.\n  - Save or copy the image to your blog's images directory ([customize][e6198daa]).\n- **Insert table** (`markdown-writer:insert-table`) and **jump to next table cell** (`cmd-j cmd-t`).\n- **Format table** (`markdown-writer:format-table`) with customizable table alignments.\n- **Continue lists and table rows** when press `enter` ([customize][adaa9527]).\n- **Correct ordered list numbers** (`markdown-writer:correct-order-list-numbers`).\n- **Toggle headings**: `ctrl-alt-[1-5]` to switch among `H1` to `H5`.\n- **Toggle text styles** ([customize][7ddaeaf4]):\n  - `code` (`cmd-'`)\n  - **bold** (`cmd-b`)\n  - _italic_ (`cmd-i`)\n  - ~~strike through~~ (`cmd-h`)\n  - `'''code block'''` (`shift-cmd-\"`)\n  - `\u003ckbd\u003ekey\u003c/kbd\u003e` (`cmd + k`)\n  - `- unordered list` (`shift-cmd-U`)\n  - `0. ordered list` (`shift-cmd-O`)\n  - `\u003e blockquote` (`shift-cmd-\u003e`)\n  - `- [ ] task list` (`markdown-writer:toggle-task`)\n- **Jumping commands**:\n  - Jump to previous heading (`cmd-j cmd-p`)\n  - Jump to next heading (`cmd-j cmd-n`)\n  - Jump to next table cell (`cmd-j cmd-t`)\n  - Jump to reference marker/definition (`cmd-j cmd-d`)\n- **Folding commands**:\n  - Fold all headings (`markdown-writer:fold-headings`)\n  - Fold and focus current heading (`markdown-writer:focus-current-heading`)\n  - Fold all inline links (`markdown-writer:fold-links`)\n- **Open links**:\n  - **Open link under cursor in browser** (`markdown-writer:open-link-in-browser`).\n  - **Open link under cursor in editor** (`markdown-writer:open-link-in-file`).\n- **Markdown cheat sheet** (`markdown-writer:open-cheat-sheet`).\n\n[adaa9527]: https://github.com/zhuochun/md-writer/wiki/Settings#use-different-unordered-list-styles \"Customizations\"\n[e6198daa]: https://github.com/zhuochun/md-writer/wiki/Settings#change-image-directory \"Change Image Directory\"\n\n### CriticMarkup\n\nFollowing [CriticMarkup][f99bc01e] commands are supported:\n\n- Addition `{++ ++}` (`markdown-writer:toggle-addition-text`)\n- Deletion `{-- --}` (`markdown-writer:toggle-deletion-text`)\n- Substitution `{~~ ~\u003e ~~}` (`markdown-writer:toggle-substitution-text`)\n- Comment `{\u003e\u003e \u003c\u003c}` (`markdown-writer:toggle-comment-text`)\n- Highlight `{== ==}{\u003e\u003e \u003c\u003c}` (`markdown-writer:toggle-highlight-text`)\n\n[f99bc01e]: http://criticmarkup.com/users-guide.php \"CriticMarkup\"\n\n### AsciiDoc\n\n[AsciiDoc][0e2299b8] is supported with [language-asciidoc][2f0cb1f9] installed.\n\n[0e2299b8]: https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/ \"AsciiDoc Quick Reference\"\n[2f0cb1f9]: https://atom.io/packages/language-asciidoc \"AsciiDoc Language Package for Atom\"\n\n### Plugins\n\n**Toolbar for Markdown Writer** is available at [tool-bar-markdown-writer][82a2aced].\n\n[82a2aced]: https://atom.io/packages/tool-bar-markdown-writer \"Toobar for Markdown Writer\"\n\n## Installation\n\n- In Atom, go to Settings (`cmd-,`) -\u003e Install -\u003e Search `Markdown Writer`.\n- Or, run `apm install markdown-writer`.\n\nAfter installation, you can find and trigger any feature through:\n\n- Open Command Palette (`shift-cmd-P`), enter `Markdown Writer` and find all the commands\n- Or, go to menu `Packages -\u003e Markdown Writer`.\n\n## Setup\n\nExecute command `Markdown Writer: Create Default keymaps` to add the recommended keymaps to your configs. You can modify them based on your needs ([wiki][31ebd53f]).\n\n- `Enter`, `Tab`, `Shift-Tab` are registered by default. You can disable them in _Package's Settings \u003e Keybindings_.\n\nConfigure your Package's Settings. Menu: _File -\u003e Settings (`cmd-,`) -\u003e Packages -\u003e Markdown-Writer -\u003e Settings_.\n\n- To **manage tags/categories in front matter**, follow this [setup][35eb9cc2].\n- To **manage all/advanced configurations (e.g. project specific settings, change italic text styles)**, follow this [setup][7ddaeaf4].\n\n[31ebd53f]: https://github.com/zhuochun/md-writer/wiki/Settings-for-Keymaps \"Settings for Keymaps\"\n[3ecd2daa]: https://github.com/atom/settings-view/issues/356 \"Viewing a package's settings should activate it\"\n[35eb9cc2]: https://github.com/zhuochun/md-writer/wiki/Settings-for-Front-Matters \"Settings for Front Matters\"\n[7ddaeaf4]: https://github.com/zhuochun/md-writer/wiki/Settings \"Settings\"\n\n## Contributing\n\nYour contributions are really appreciated. You can follow [CONTRIBUTING](https://github.com/zhuochun/md-writer/blob/master/CONTRIBUTING.md) guide to get everything started.\n\n## Project\n\n- View [CHANGELOG][e45121fa] :notebook_with_decorative_cover:\n- Bugs, suggestions or feature requests, [open an issue][e6ad7ed1] :octocat:\n- Star [GitHub repo][e8960946] and [Atom package][91a1b9c2] to support this project :+1:\n- License in [MIT][6a9a3773] :unlock:\n- Shipped by [Zhuochun][41ae693b] :sunny: and [contributors][f303810e] :clap:\n\n[e45121fa]: https://github.com/zhuochun/md-writer/blob/master/CHANGELOG.md\n[e6ad7ed1]: https://github.com/zhuochun/md-writer/issues\n[6a9a3773]: https://github.com/zhuochun/md-writer/blob/master/LICENSE.md\n[41ae693b]: https://github.com/zhuochun\n[f303810e]: https://github.com/zhuochun/md-writer/graphs/contributors\n[e8960946]: https://github.com/zhuochun/md-writer\n[91a1b9c2]: https://atom.io/packages/markdown-writer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhuochun%2Fmd-writer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhuochun%2Fmd-writer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhuochun%2Fmd-writer/lists"}