I spent a long time researching, trying and tweaking text editors. As a cross-platform developer and technical writer (mostly writer these days) I work with different programming languages, document formats and want an editor with particular features, but that is also easy on the eye. Ideally I wanted all the functionality I was looking for in one application, not split between 5.
Here's what I was looking for:
- Good Markdown support.
- The ability to export markdown to different formats (at least PDF and HTML).
- A project manager.
- Spelling and grammar checking.
- The ability to edit code inline (in markdown) as well as in separate files and for it to be formatted and highlighted correctly.
- An extension / plugin architecture for features I don't even know I want yet.
Open Source would be a bonus, but it wasn't essential. I am happy to pay for software, but cost isn't always an indication of quality.
I tried Sublime for a while but got bored with it and can't even remember why. I tried BBEdit (and TextWrangler), I liked that it was Mac-native but it lacked a lot of the features I required for the money it cost. I tried Brackets some time ago, and again I can't remember what I didn't like about it, but I moved on quickly. TextMate was nearly there, but again it wasn't worth the money, I would still need other tools.
Then I found Atom from GitHub. I wasn't immediately convinced, versions prior to version 1 were unreliable and certain features necessary to me didn't work well (HTML and PDF export), but something about Atom made me want to stick with it.
Atom is a text editor, so of course will work with anything text-related. However they are often primarily aimed at coders and setting things up for a more writing focused workflow takes a few steps and after months of tinkering I have arrived at a near perfect (I will regret saying that) setup for me and I wanted to share what I use, how I've configured it, and what it helps me do.
I'm considering making an Atom fork or special package file that bundles these writer specific plugins and setting together, but that's still an idea.
Making Atom Look Nice(r)
I like light themes, and use one-o-eight-syntax in light and bright variants.
It looks like this (plus other additions which I will cover next).
I used to have a couple of customisation in my styles.less file, but I have removed all of them now, so this is default.
I use the Unity UI theme, as I like my Mac software to look like Mac software.
Atom HTML Preview is great for previewing HTML files.
I have increasingly poor eyesight, and I find Highlight Line helpful for identifying where I am in a document. It's also customisable to suit your needs.
Atom Beautify is a comprehensive package that formats your code (and text), and lets you configure what 'beautifier' to use for what supported language.
And then triggering the command will tidy your code/text for you.
In conjunction with Atom Beautify I use the Tidy Markdown package that I find does a better job than the inbuilt package.
Personally I am not a big fan of the 80 character per line limit, as you can achieve this with layout and flow accordingly. But if you work with projects who insist on it, you can use Break Line Length to force line breaks at a defined length before submitting your work.
Multi wrap guide lets you set wrap guides at configurable positions, it should also work with the package above to break text at these positions.
Pigments shows colour values inline, simple but nice 😀.
Language Formatters, Linters and Snippets
Many of these will be self-explanatory (and I wont include screenshots), they add language highlighting, formatting and snippets (Snippets are one of the Atom features I've just started using) to Atom, in varying degrees:
- django-templates - I work a lot with Jekyll, and its templates are liquid, which are based on django templates.
Why waste time repeating yourself when packages can help!
The autoclose-html package adds closing tags to HTML elements you add into your code or code snippets.
The Jekyll package is a comprehensive package that adds Jekyll snippets, shortcut methods, grammars, server management and is configuration aware (of the contents of your Jekyll config.yml file). I should use this package more, but it frequently doesn't work and isn't very verbose.
Using Color Picker you can summon a pop-up colour picker inline in your files.
Project Manager allows you to set folders as projects and then open and switch between them.
If you can't remember the name of a file or the correct path to it, autocomplete-paths will help. Sometimes it can be too keen, requiring judicious use of the esc key to stop inserting file names all over your document.
Make your project view look nicer with colourful file type icons from file-icons. The Unity UI theme hides these, so make sure you show them by checking the Force Show setting in the package settings.
git-time-machine is a great package that lets you browse and compare git history for a file in Atom.
The Pull requests package is super cool, allowing you to view comments on pull requests inline in your file. It occasionally times out on network connections and I had issues with private / business repositories, but it usually catches up.
OK, this is what you're really interested in 😉.
I have been using linter-write-good for some time and have found it useful. It offers suggestions to make your writing better based on the NPM write-good module. It wont always be right or relevant, but it has helped me a lot.
I am still undecided on Alex Linter, it uses AlexJS to catch inconsiderate writing. I have found it overly sensitive, highlighting words like Australian and American as 'potentially profane', which is odd. It will also highlight words with double meanings, such as 'shoot a photo'. I'm still assessing how useful it is to me.
I replaced the inbuilt spell checker in Atom, because the Spell Linter allows you to select dictionaries (You can switch between UK and US English 😄), add custom words (great for tech jargon), and it has a nicer interface. You will need a lspell compatible dictionary installed (I installed Aspell with Homebrew) and the intentions package which adds a nice pop-up over issues that I wish other packages would use.
Typewriter "improves your writing experience" by centring the layout removing scroll-bars (unless you scroll) and other tweaks. I'm not 100% on this package, as sometimes (and this may be package conflicts) it creates unnecessary horizontal scrolling and I end up with a lot of white space, which I know is kind of the point of the package, but I'm not a big fan of it 😬.
The Wordcount package counts words and characters. Simple.
Markdown Writer provides a set of shortcuts and functions for making working with Markdown easier. It also works well with static site generators that use Markdown for posts.
It can be jumpy, but Markdown scroll sync keeps your source and preview markdown in sync with each other.
Packages from Me
If you like writing in Markdown, but also use Medium, then my Medium Export lets you export straight to your Medium drafts. It needs work, but functions fine.
I am also working (slowly) on the 'Editors friend' package that sets configurable lists of search/replace strings to help reduce the amount of repetitive editing you do.
What's in your Atom?
And that's me! I love the extensibility of Atom and would welcome your comments on how you've set it up for your needs.