Frequently Asked Questions
- Spell-check doesn't work; how do I enable it?
- Some of my Markdown elements aren't highlighted
- Which elements of Markdown are supported?
- Autocompletion doesn't work
- Syntax-highlighting is broken after uninstall
- Trailing whitespace is automatically removed, but I don't want that
Spell-check doesn't work; how do I enable it?
spell-check doesn't scan documents in the
text.md by default. You can easily add this yourself:
- Open the Atom settings, and find the Packages tab
- Search for the
spell-checkpackage; you can find it under the Core Packages
- Open the settings for
text.mdto the list of grammars (make sure the scopes are comma-separated)
- Reload Atom to make sure the updated settings take effect
Some of my Markdown elements aren't highlighted
language-markdown parses your Markdown document; it does not directly color the different elements. This is done by the syntax-theme you are using. There's a good chance that your syntax-theme doesn't support all the different elements that
language-markdown recognizes. You can ask the author of the theme to add better support for
language-markdown, or add styles to your custom stylesheet. You can also try one of the tried and tested syntax-themes featured above. If you can't get it to work, feel free to open an issue, and I'll see what I can do.
Which elements of Markdown are supported?
Because there is no clear Markdown standard, I've chosen to follow the CommonMark Spec as closely as possible within the Atom environment. On top of that, I've implemented support for a few extensions: Github Flavored Markdown, Markdown Extra, CriticMark, Front Matter, and R Markdown. Together, I believe these specs cover a solid 98% of your day-to-day Markdown needs. If you feel that an element is missing, please open an issue.
Notes on implementation
htmlis included when you have the default
- The Github Flavored
task-listsare implemented as part of 'normal'
- Setext-headers (underlined-headers) are not supported
indented-code-blockshave been disabled to prevent false-positives; use
fenced-code-blocksinstead (more details)
- Github tables require pipes at the start of each line, and cells need a padding of at least one space; this is a suggested convention to prevent false positives
Autocompletion doesn't work
Autocompletion doesn't work out-of-the-box with Markdown documents. It is possible to enable it, but it might need some tinkering. In the
autocomplete-plus settings, make sure that Markdown files aren't blacklisted. Additionally, it might help to switch the default provider to Fuzzy.
For Atom to index your Markdown documents as symbols, you have to add the following to your
'.text.md': autocomplete: symbols: constant: selector: "*" typePriority: 1
You can find additional information in this issue.
Syntax-highlighting is broken after uninstall
language-gfm is automatically disabled (unless you've enabled the setting that prevents this) when using
language-markdown to avoid any conflicts. Because
language-markdown is intended as a drop-in replacement you most likely won't need both anyway. However, if you uninstall
language-gfm doesn't automatically get re-activated. There's no API available to do this, so you'll have to re-activate
language-gfm manually, which is quite easy.
- Open the "Settings" and go to the "Packages" tab
- Search for
Enableto re-activate it
- You probably want to reload Atom to make sure the change takes effect
Trailing whitespace is automatically removed, but I don't want that
By default, Atom removes all trailing whitespace when a file is saved. You can disable it by setting the following flag in your
config.cson for the
.md.text scope. For more background, see #115.
'*': # all current config '.md.text': whitespace: removeTrailingWhitespace: false