Companion piece to academic writing workflow, wherein I will mention plaintext lifestyle choices available without the complicated fiddly academic bits such as citations.
- people who possibly don’t live inside text editors.
- who don’t need equation support.
- who don’t need citation support.
How hard can it be?
There are lots of tools to do this. There are in fact a few hundred static site generators for plain text blogging.
The top few, for academics at least, seem to be
- Jekyll (ruby),
- Pelican (python)
You can find many more.
Some, like lettersmith take a DIY route; just make a simple blog without excessive abstraction
I use Pelican.
As to why I chose Pelican over Jekyll: I am more fluent in Python than Ruby, and those were the two prominent options at the time.
Due to the inscrutable tides of hype, Hugo/Blogdown might be the most popular move now, especially if you want to access the mind-share of other academics, such as the rbind community.
See also the blogdown-book.
Gatsby is even fancier with so many features I cannot track them, although it is less focussed on my academic needs.
A lot of these are made easier if you have a localhost dev server.
Caddy has a builtin automatic hugo editor.
Some themes have been tested against blogdown.
hugo-academic is recommended for scholarly types.
I use the hosted Disqus system but it is bloated and suspect, so I seek alternatives.
Here are a few overviews of options.
One could host a server running its own comment system. Schack is a simple node.js nice one supporting various 3rd party authentication. Another simple alternative is isso ( python) it has no third party authentication support so I am nervous about having to do my own account management.
A small amount of work can repurpose github as a comment system, although it is a little clunky, and require your users to be prepared to open github issues if they want to comment, which is nerdier than one would like. This can be made smoother with utterances which automates some of the legwork in github comments at the cost of needing a helper app to run. Similarly, staticman is an (optionally) hosted (open source) app that integrates comments into your source. There is also a hop Go option called remark42
In the past, I used many online services to handle my information; but I’ve been burned too many times by these businesses going under, or being too inflexible to evolve with my workflow, or relying on me being constantly online, which is not a given in many parts of the world I want to work. Waste of time, loss of data. (So long, delicious.com, citeulike.org, evernote, google docs…) Fuck that.
The only online services I use these days are:
Zotero, which avoids the bulk of the above criticisms by the fact that it’s open-source, works great offline, is backed by a presumably comparatively benevolent university, and handles only information that I wish to share.
github isn’t open-source, but the underlying technology it facilitates, git, is, and the github itself is replaceable for my purposes, so I’m happy to benefit from the commercial sheen they buff on the bare pipes.
netlify is a hosting/CDN/etc provider with good github integration that one might use instead, with especially fancy gatsby integration
I pay for the services of github and Zotero in the hope it will ensure ongoing support (actually - github unilaterally declared my account to be free so…). Technically speaking, I am minimally committed to either of them in any case,; all the data I have on these services is in open formats and can be (and has been) migrated to and from other platforms.
There are many options now if you use markdown. A brief note here. Markdown preview extended turns atom or vs code into good markdown editors, including mathematical equations.
For a combination blogging tool and encrypted markdown edition note storing you might want to use something like standard notes, which costs some money when you use the bells and whistles, although might be worth it if you nots include some confidential ones.
Preview tools make it all nicer.
- marked is cheap macOS editor…
- … inspired by notational velocity, specifically nvALT, which has its own noteworthy features, like high tech search.
- Atom has a built-in markdown preview
- mou has an pretty design and is cheap
- and (free! opensource! mou-like design): Macdown
- livereload turns any browser into a preview tool.
- cactus is a plain website generator, that features a GUI-ish client, cactus for mac
- gitbook is a markdown website GUI and publishing toolchain
- classeur is also one, but focuses even on standard blogs not just nerd websites
- “Prose provides a beautifully simple content authoring environment for CMS-free websites. It’s a web-based interface for managing content on GitHub. Use it to create, edit, and delete files, and save your changes directly to GitHub. Host your website on GitHub Pages for free, or set up your own GitHub webhook server.”
- livereload integrates several tools, including a GUI, for rendering various blogs on demand. Semi-nerd, semi- public.
Gitit is a wiki backed by a git, darcs, or mercurial filestore. Pages and uploaded files can be modified either directly via the VCS’s command-line tools or through the wiki’s web interface. Pandoc is used for markup processing, so pages may be written in (extended) markdown, reStructuredText, LaTeX, HTML, or literate Haskell, and exported in ten different formats, including LaTeX, ConTeXt, DocBook, RTF, OpenOffice ODT, and MediaWiki markup.
Draft, if the offline mode works, might even do all this with a nice UI.
Other things to audit for UI goodness: