Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 6.99 KB

atom.md

File metadata and controls

101 lines (64 loc) · 6.99 KB

Atom editor

Contents

Atom editor with full Unicode support

Highly recommended to install Atom editor as it's the best for markdown. Atom is perfect for Unicode rich texts. But you need to install some fonts and set font fall-back chains first. See this instruction in SugarTeX docs.

See Open fonts for serif and sans serif fonts.

If you are interested in beautiful fonts and on Windows take a look at MacType font rendering engine.

Atom packages for right Pandoctools experience

SugarTeX Completions

Install SugarTeX Completions package for easy typing SugarTeX and lots of other Unicode characters. (it's incompatible with latex-completions package).

In the SugarTeX documentation appropriate shortcuts for SugarTeX Completions for Atom are given.

Unix Filter

Install Unix Filter (>=0.0.2). It nicely runs on Windows too. It runs Pandoctools right from Atom and writes output file (though profile confirmation prompt is not shown). It's convenient to use it with file-watcher.

Specify command option to <...>\pandoctools.exe --stdin "%FILE%" (<...>/pandoctools --stdin "$FILE" on Unix) where <...> is a path to pandoctools executable that can be learned from desktop shortcut. And uncheck "Replace Text" option.

Hydrogen

Install Hydrogen (by nteract) Atom package that allows interactive python code execution. With it you can run and see instantly see results of code blocks that are later would be processed by Pandoctools/Knitty and be included to the output document.

See the short instruction how to use and set up Hydrogen.

Reload imported modules in Hydrogen

Reload imported modules in Hydrogen

Recommended Atom options

  1. In Settings → Editor turn on Soft Wrap and Soft Wrap At Preffered Line Length. This setting is convenient for inspection of markdown code that was obtained from untrusted source,
  2. Enable opening markdown files right from the Windows shell (from Explorer). In Settings → System turn on three checkboxes.
  3. Sometimes some Atom packages break spell check and the clear install may be the easiest option. As stated here if on Windows in order to delete Atom completely you should uninstall it and then delete it's files from %USERPROFILE%\.atom, %LOCALAPPDATA%\atom and %APPDATA%\Atom.

Enable Atom spell checking

As far as I know it works only with language-gfm (GitHub flavored Markdown package). May be I'm wrong though.

English spell checking works on Atom and I was able to make russian and english spell checking work simultaneously. In order to make it work you should specify something like en-US, ru-RU in Locales setting and C:\Dictionaries in Locale Paths setting of spell-check module (by atom). Then put en_US.aff, en_US.dic, ru_RU.aff, ru_RU.dic to that folder (you can download the Hunspell dictionary). Or you can use dictionaries from LibreOffice like Russian spellcheck dictionary. They can be found in %PROGRAMFILES%\LibreOffice 5\share\extensions or %APPDATA%\LibreOffice\4\user folders (you can search for *.dic files). I renamed russian-aot.aff, russian-aot.dic files to ru_RU.aff, ru_RU.dic and changed their encoding to UTF-8.

Useful Atom packages

Optionally install some Atom packages useful for Markdown and Hydrogen:

  • MagicPython (by MagicStack): syntax highlighter for cutting edge Python 3 (default Atom highlighter does not support Python 3).
  • document-outline (by mangecoeur): navigation sidebar with table of contents of markdown document when editing.
  • character-table (by klorenz): insert any Unicode character via name search,
  • charcode-display (by yonchu): display the code of the character under the current cursor position in the status bar.,
  • markdown-table-editor (by susisu): automatic markdown table editor/formatter,
  • file-watcher (by lwblackledge): helps simultaneously open and edit files in two editors. To use it with PyCharm you should disable PyCharm "safe write" (Settings → Appearance and Behavior → System Settings → Synchronization → Use "safe write").
  • git-time-machine (by littlebee): see difference with any older Git commit (if you add markdown document to the Git repository). This can be useful for authoring edits (7zip the whole repository and send).
  • highlight-bad-chars-bl (by ohanhi and kiw0fruit): highlights some Unicode characters that can be confused with standard ANSI (like no-break spaces). The package might be buggy so you may need to periodically edit the file to make the package work.
  • github-atom-light-syntax (by primer): light syntax theme. Worth adding some tweaks to styles.less to make it work better with SugarTeX and Knitty: 
    .syntax--comment {
  font-style: italic;
  color: #999 !important;

  .syntax--markup.syntax--link {
    font-style: italic;
    color: #069;
  }
}

.syntax--comment.syntax--block {
  font-style: normal;
  color: #666 !important;
}

.syntax--string {
  font-style: normal !important;
  color: #069 !important;
}