Use the Markdown Editor app in Nextcloud | Opensource.com

Use the Markdown Editor app in Nextcloud

Nextcloud has one of the smoothest editors of the popular Markdown file type, with lots of convenient and intuitive features.

Digital images of a computer desktop
Image by : 

Opensource.com

x

Subscribe now

Get the highlights in your inbox every week.

The advantage of plain text is that there’s no extra computer-specific information cluttering up your otherwise human-readable writing. The good thing about computers is that they’re programmable, and so as long as we humans agree to follow very specific conventions when writing, we can program computers to interpret human-readable text as secret instructions. For instance, by surrounding a word with two asterisks, we not only give a visual cue to humans that a word is significant, but we can also program computers to display the word in bold.

This is exactly the theory and practice behind Markdown, the popular plain text format that promises writers that as long as they use specific plain text conventions, then their text will be rendered with a specific style.

Traditionally, that has meant that an author writes in plain text and doesn’t see the pretty styling until the text is fed to a converter application (originally markdown.pl), but the Markdown Editor app in Nextcloud changes that.

With Nextcloud’s Markdown Editor, you can type in plain text while seeing the style it renders. This is a gamechanger for authors who struggle to remember Markdown’s sometimes confusing notation (do the brackets become before or after the parentheses in a hyperlink?) or who just don’t like the look of plain text. And better yet, it runs in the (Next)cloud, so it’s available to you anywhere.

Install

To use Nextcloud’s Markdown Editor, you must have an install of Nextcloud. The good news is, Nextcloud is surprisingly easy to install. I’ve installed it on a Raspberry Pi, on a shared server, and even as a local app (which is silly, don’t do it). If you don’t trust your own abilities, you can even rely on Turnkey Linux to do the hard part for you, or else just purchase managed hosting directly from Nextcloud.com. Once you have Nextcloud installed, adding apps is simple. Click on your user icon in the top right corner of the Nextcloud interface and select Apps. Navigate to the Office and Text category and click to install and enable the Markdown Editor.

Launching

After activation, the Markdown Editor gets associated with any file ending in .md in your Nextcloud files, so when you open a Markdown file, you launch Markdown Editor.

Using Markdown Editor

The Markdown Editor contains a large text field for you to type into and a single toolbar along the top.

The toolbar contains the basic functions of a word processor—styling your text with bold, italics, and strike-through, creating headings and paragraphs, lists, and so on.

Many of these functions get invoked automatically as you type if you know Markdown. If you’re not familiar with Markdown, then the toolbar or the usual keyboard shortcuts (Ctrl+B for bold, Ctrl+I for italics, and so on) help you style your text.

The great thing about the way Markdown Editor works is that it truly is all things for all users: if you want to type in Markdown, then it accepts that and instantly converts it into visual styling, and if you don’t want to think about Markdown, then it generates the style for you when you use keyboard shortcuts or toolbar buttons. Either way, you never have to see the Markdown syntax, but you also never lose it. It’s the perfect compromise.

It’s an awfully smart editor, too. It offers to create a hyperlink for you when you select a word, it auto-converts Markdown quickly and smoothly, and it knows a few different "flavors" of Markdown syntax (Commonmark primarily, but also traditional Markdown, Github Markdown, and so on).

Try Nextcloud

I’ve used a few Markdown preview applications, and Nextcloud’s Markdown Editor is one of the smoothest. It respects its user and does the bare minimum to display Markdown, so its conversion is fast and accurate. Because it’s an app in Nextcloud, you also get the benefit of having your work saved instantly, with version control, on your own private, open source cloud. Text editing doesn’t get much better than that.

Cheat Sheet cover image

Learn Markdown syntax to be ready to contribute to open source software.
Digital images of a computer desktop

The open source cloud collaboration suite has made major gains in recent years. Take a look at what you've missed.
Sky with clouds and grass

These apps for the Nextcloud file sync and share tool make it easy to create documents and collaborate with your team.

Topics

About the author

Seth Kenlon
Seth Kenlon - Seth Kenlon is a UNIX geek, free culture advocate, independent multimedia artist, and D&D nerd. He has worked in the film and computing industry, often at the same time. He is one of the maintainers of the Slackware-based multimedia production project Slackermedia.