doc22940 / language-markdown

Markdown grammar

A realistic implementation of various Markdown specifications as a flexible, drop-in alternative for language-gfm. Adds smart context-aware behavior to lists, and keyboard shortcuts for inline emphasis and links/images.

Installation

1. Install language-markdown via either

• your terminal: apm install language-markdown
• the Atom GUI: Atom > Settings > Install > Search for language-markdown

2. Select language-markdown as your Markdown grammar. Open a Markdown file and

• press ctrl+shift+L and choose "Markdown"
• choose "Markdown" from the grammar selection interface in the bottom right-hand corner of the window

To avoid conflicts this package tries to disable the core package language-gfm. If you run into any issue, make sure you've selected the correct grammar.

Supported grammars

• CommonMark Markdown
• Github Flavored Markdown (including AtomDoc)
• Markdown Extra
• CriticMark annotation
• Front Matter (yaml, toml and json)
• R Markdown

Additional features

• Smarter lists
  • Automatically create new list-items when pressing enter
  • Indent or outdent list-items by pressing tab or shift+tab
  • Toggle tasks with cmd+shift+x or ctrl+shift+x
  • Remove empty trailing list-items when pressing enter
• Add shortcuts (via _, * and ~) for toggling inline-emphasis and strike-through on selected text
• Add shortcuts for converting selected text to a link (via @) or an image (via !)
• Supports embedded HTML- and Liquid-tags
• Embedded math functions (via language-latex and language-mathematica)

Syntax-theme support

By default, most syntax-themes only provide basic styling for .markup classes. This package provides additional, more specific classes which are supported by the following syntax-themes:

• minimal-syntax (light, high-contrast)
• minimal-syntax-dark (dark, high-contrast)
• pen-paper-coffee (light, low-contrast)
• pubster-syntax (dark, high-contrast)
• one-o-eight-syntax (various, medium-contrast)
• east-end-syntax (light, medium-contrast)
• east-end-notebook-syntax (light/lined, medium-contrast)

If you are interested in adding support for all .markup classes to your syntax-theme, take a look at the relevant section in the contribution guide.

F.A.Q.

If you run into any issues, consult the F.A.Q. first. Amongst other things, this document contains information about common issues involving:

• spell-check
• autocompletion
• syntax-highlighting
• whitespace

Contributing

If you want to contribute to this package, have a look at the contribution guide.