Markdown Simplifies Formatting Your DW Posts

[jesse_the_k]

Markdown is a minimal way to format your text. The goal is to use "natural" formats, similar to email. Software that understands Markdown translates it to HTML. Markdown is much easier--and more forgiving--than HTML. This post has the markdown you'll use the most. The rest of the features are explored later.

The full spec is hosted by its creator, Jon Gruber https://daringfireball.net/projects/markdown/syntax

Using Markdown Here at Dreamwidth

Markdown is welcome everywhere except in subject lines. You can use it for posts, comments, email posts.

Markdown is a silent feature inside Dreamwidth's HTML editor. You turn it on by making the first line of the post:

!markdown

Now Dreamwidth interprets any Markdown you type. By definition, Markdown includes HTML, so you can also use HTML to format your post—for Dreamwidth cuts, image embeds, and any other HTML task.

---

Bold, strong, italic, emphasis

Begin and end text with either _ underscore or * asterisk

Use ONE for emphasis aka italic

Use TWO for strong aka bold

Markdown:

The *rain* in _Spain_ falls *mainly* on _the Plain_. I **‌think** she's __got it__, she's **‌finally** got __IT__!

Displays as:

The rain in Spain falls mainly on the Plain. I ‌think she's got it, she's ‌finally got IT!

---

DW usernames

Prefix the account with an "@" sign

@jesse_the_k ⇒ jesse_the_k

@access_fandom ⇒ access_fandom

@dw_news ⇒ dw_news

Usernames elsewhere

For other sites, use the format @username.site

Some examples:

@jesse_the_k.ao3 ⇒ jesse_the_k

@jesse-the-k.tumblr ⇒ jesse-the-k

@jesse_the_k.twitter ⇒ jesse_the_k

see DW FAQ 87 for all the supported sites

ETA: I originally had this wrong--thanks to bluewinged_songbird and syntheid for setting me straight!

---

Lists

Markdown:

Bullet lists begin and end with a blank line

- then any number of lines that
- begin with a hyphen 
    - and a space 
- like this one

must have a blank line to turn off the list

Displays as:

Bullet lists begin and end with a blank line

• then any number of lines
• that begin with a hyphen
• and a space
• like this one

must have a blank line to turn off the list

---

Numbered lists (called ordered lists <ol> in HTML) use digits instead of hyphens. The presence of a digit and a period is what does it:

Markdown:

must have a blank line

4. then any number of lines
1. that begin with a digit and  
290. then a period, like this one
2. and this one
2. and so on

must have a blank line to turn off numbering

displays as:

must have a blank line

1. then any number of lines
2. that begin with a digit and
3. then a period, like this one
4. and this one
5. and so on

must have a blank line to turn off numbering

The value of the number doesn't matter, and the list always starts at 1!

Horizontal rule

Three or more asterisks, with blank line before & after. Markdown:

***

Displays as:

---

[ETA: this also works with hyphens, but hyphens will end your post early when you're replying or posting by email]

LINKS

Inline

Write your link text (aka anchor) in square brackets immediately followed by the URL in parentheses.

Markdown:

The source repository is located at [Dreamwidth's GitHub Repositories](https://github.com/dreamwidth/).

Displays as:

The source repository is located at Dreamwidth's GitHub Repositories.

Go bare

Enclose URLs and email addresses within angle brackets and they're clickable

<https://example.com> ⇒ https://example.com/

<address@example.com> ⇒ address@example.com

---

CODE SAMPLES

Surround code with ` backtick

Markdown: Remember to turn on this feature by beginning your post or email with `!markdown` followed by a blank line.

Displays as: Remember to turn on this feature by beginning your post or email with !markdown followed by a blank line.

Comments

[redbird]

Thank you!!

[jesse_the_k]

<3

[capri0mni]

Thank you! I will be signal boosting.

I think this will help make the Tumblr refugees more at ease.

(I was not planning on a rhyme...)

But I love it when you

[jesse_the_k]

rhyme, or assonate, or .... whatever.

[squidgiepdx]

Bookmarking - THANK YOU! :)

UR WELCOME

[jesse_the_k]

...a lot

[delight]

I use markdown because it makes mobile way easier and because my word processor of choice uses it. I can't wait for it to be a thing in comments because I use mobile commenting way more than posting.

[jesse_the_k]

+100

Also, reply-by-email defaults to markdown--you don't even have to add the !markdown on-switch.

[kore]

Wow, v helpful! Thanks!

[jesse_the_k]

Ooops, I wanted to say that to somebody else.

/o\

[mdlbear]

Nice! A couple of questions:

1. Does it support ```...``` fencing for multi-line code snippets? (Github Flavored Markdown and maybe others)?

2. Can Markdown conversion get done on posts submitted via XML-RPC? (This isn't all that important to me, since I pipe Markdown drafts through pandoc in my client, but it could make a difference to folks with other clients.)

[cbrachyrhynchos]

No, DW doesn't support code fences, and probably not most of the github/pandoc extensions.

[emceeaich]

I need to dig through the repo to see which markdown engine is used here. At Mozilla we just enabled Markdown comments in Bugzilla, and that engine implements the GitHub flavor. Maybe someone could try dropping it in?

[jesse_the_k]

The code she is SO OLD.

They link to Jon Gruber's original spec, so I suspect it dates back to that engine.

[luzula]

Huh, I had no idea, thank you! I mean, I'd have to retrain myself from html, but this does look like it would save some typing.

[jesse_the_k]

While I use a keystroke utility to generate HTML, the Markdown lists are way easier to manage. I also use a markdown aware editor which offers HTML preview, so I never make my posts "live" in DW.

[bluewinged_songbird]

Oh this is nice! Very concise and straightforward.

One thing, you can actually use markdown for usernames on other sites too. Per syntheid's post, it would look like @something.twitter

[jesse_the_k]

Thank you for this invaluable information--I've edited the post to include it!

[raino]

Thanks! This is super useful!

[jesse_the_k]

Glad to be of service.

[replyhazy]

How nice!

Though if I post by email, I know I have to be careful of the horizontal rule. My email posts used to get cut off at the HR.

[jesse_the_k]

Good to know (and mysterious).

[finch]

Thank you for this! I'd picked up some of the markdown by osmosis but this actually makes it usably clear for me!

[jesse_the_k]

I'm thrilled to have been "usably clear"!

[swingandswirl]

... you are WONDERFUL. /hands big basket of treat of choice/

/saves to Evernote/

You're welcome!

[jesse_the_k]

/twirls big basket of GF gingersnaps/

[thedarlingone]

Woohoo! I generally use HTML in the posting box (I am a Livejournal fossil and gave up on rich text editors a long time ago), but that's been kicking my tail on mobile posts. So I've actually been using Markdown formatting but not knowing how to make it apply, just leaving it "bare". This is *amazing*. :D

(And I will be very happy when it works in comments as well. ^_^)

[jesse_the_k]

Turns out that one of Jon Gruber's design principles for Markdown was "even when you read it bare, it makes sense." Because we have been using asterisks for emphasis, and greater-thans for quoting, since email.

So! You were acting on insight!

[ligie]

It makes mobile posting so much easier. Thank you!

[jesse_the_k]

I'm thrilled to be an enabler.

[applenym]

Thank you!! This is so helpful, especially since I use a markdown editor to write my posts already.

Sorry for the late reply

[jesse_the_k]

Which editor do you use?

I use both iPad and Mac, so I've settled on iA Writer, which keeps things in sync just magically. It, tragically, lacks a share sheet/system service, so it's not as automated as I'd like.

[silveradept]

Much appreciated. Occasionally it's easier to think in Markdown when trying to compose, and I keep forgetting that it's an option for Dreamwidth.

Happy to help

[jesse_the_k]

Thinking in Markdown sounds intriguing. Do hyphens and octothorpes clutter up your hair?

[zenolalia]

Ah, fantastic! Thank you for letting us know about this rad feature!

[jesse_the_k]

My truly great pleasure.

[tropicsbear]

I wasn't aware that there was a way to do the other-site-username with Markdown *A* Thanks for putting this together! Hope it's okay if I link to this.

Link as widely as you wish!

[jesse_the_k]

I'm fortunate that the magic of linking around taught me that!

[goodbyebird]

Very useful, thanks!

[jesse_the_k]

You're most welcome

[naraht]

Wow, this is really useful, thanks!

[jesse_the_k]

Happy to help.

[lovepeaceohana]

Oh my god, is markdown the reason fandom seems to have permanently adopted *** as page/scene separation marks?!

This is a great question

[jesse_the_k]

...and I don't know the definite answer, "fandom" being a rather large target.

I do know I've read handset books from the 19th century that used three or five centered asterisks as scene breaks, so I think it predates typewriters :,)

[genarti]

Oh this is fascinating! I had no idea. Thanks so much for laying it out so clearly!

[jesse_the_k]

<3

[sophus]

Oh, this is useful!

[jesse_the_k]

You're most welcome.

[felinejumper]

Holy SHIT I cannot believe the post editor accepts markdown THANK YOU THANK YOU THANK YOU.

I am so delighted

[jesse_the_k]

...to convey this info to you!

GO WILD