DEV Community

Sloan the DEV Moderator for The DEV Team

Posted on • Updated on

Best Practices for Writing on DEV: Creating a Series

Hey hey DEV Community, Sloan here!

If we haven't met, I'm pleased to make your acquaintance. I'm a moderator here on DEV, and I'm also a Hoffmann's two-toed sloth. πŸ‘‹πŸ¦₯

I'm here to share some tips for success when it comes to writing on DEV. If you’ve been looking to improve your technical writing skills, make the most of DEV as a blogging platform, and take your content to the next level β€” this series is for you!

I'll start by showing you how to make a content series on DEV. Serializing your content makes it easy for your readers to follow along through multiple steps, and it also helps you keep your content organized by theme.

DEV has two post editors: Basic Markdown and Rich + Markdown. You can set your editor type under settings > customization > writing. Here's how to create a series with each one.

Creating a Series with Basic Markdown

DEV's post editor uses Jekyll Front Matter. To create a series or add your post to an existing series, add the series variable to your front matter. Here's an example of what that would look like for this post:

title: "Best Practices for Writing on DEV: Creating a Series"
published: true
description: "A post about creating a series on DEV."
tags: meta, writing
series: Best Practices for Writing on DEV
Enter fullscreen mode Exit fullscreen mode

Creating a Series with Rich + Markdown

Select the hexagon icon at the bottom of the post editor. It looks like this:

The bottom toolbar of the DEV Rich + Markdown editor with the hexagon icon circled in red. It shows a blue rectangular "Publish" button, gray text reading "Save draft, a gray hexagon icon, and gray text reading "Revert new changes."

The post options menu will open, which will allow you to set a canonical URL, schedule a publication, and create or continue a series.

The post options menu, with open fields for setting a canonical URL, scheduling a publication, and creating a series. In the series box is written "Best Practices for Writing on DEV."

Once you add your series name the first time, it will appear in the Existing series dropdown menu for future posts.

🚨Note: If you've written the first entry in a series and are wondering why the series info is not showing up when viewing the post, it's because we don't actually display information about a post being part of a series until there is more than one entry in the series. Once you write your second entry in the series, the Table of Contents and title for the series should appear.🚨

That's it! Happy series-creating. The next installment of this series will be about formatting.

Top comments (6)

kamil7x profile image
Kamil Trusiak

Unfortunately, if you mistype series name, it will still be created, and you will have additional item inside Existing series dropdown.
I hope there will be possibility for managing series in future

erinposting profile image
Erin Bensinger

Thanks for this feedback! I'll use it to create a discussion in our public GitHub repo.

In the future, if you have feature concerns, you're welcome to open your own issue in our repo to let our engineering and product teams know directly. Open source ftw!

devshirt_club profile image • Edited

Hi Sloan, I love this guide.
I also couldn't help but notice your a fan of sloths, so I figured you would like to know about this sloth t-shirt:
male-build in progress
female-build in progress

itsdru profile image

Found this quite helpful. I ended up using the Rich + Markdown way of creating a series. However, if I need to delete a series I wonder whether it is still as simple as creating one?