jesse_the_k: Human in professorial suit but with head of Golden Retriever, labeled "Woof" (doctor dog to you)
[personal profile] 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 full spec is hosted by its creator, Jon Gruber https://daringfireball.net/projects/markdown/syntax

Using Markdown Here at Dreamwidth

You can use Markdown for new posts and when you reply by email. Right now, you can't use Markdown on the website when you're replying to posts (aka commenting on entries).

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 ⇒ [personal profile] jesse_the_k

@access_fandom ⇒ [community profile] access_fandom

@dw_news ⇒ [site community profile] dw_news

Usernames elsewhere

For other sites, use the format @username.site

Some examples:

@jesse_the_k.ao3 ⇒ [archiveofourown.org profile] jesse_the_k

@jesse-the-k.tumblr ⇒ [tumblr.com profile] jesse-the-k

@jesse_the_k.twitter ⇒ [twitter.com profile] jesse_the_k

see DW FAQ 87 for all the supported sites

ETA: I originally had this wrong--thanks to [personal profile] bluewinged_songbird and [personal profile] 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.

Page 1 of 2 << [1] [2] >>

(no subject)

Date: 2019-01-09 01:13 am (UTC)
redbird: closeup of me drinking tea, in a friend's kitchen (Default)
From: [personal profile] redbird
Thank you!!

(no subject)

Date: 2019-01-09 01:31 am (UTC)
capri0mni: A black field crossed by five parallel lighting bolts in blue, gold, green, red, and purple (Default)
From: [personal profile] 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...)

Re: But I love it when you

From: [personal profile] capri0mni - Date: 2019-01-09 11:32 pm (UTC) - Expand

(no subject)

Date: 2019-01-09 01:32 am (UTC)
squidgiepdx: (Default)
From: [personal profile] squidgiepdx
Bookmarking - THANK YOU! :)

(no subject)

Date: 2019-01-09 02:49 am (UTC)
delight: (Default)
From: [personal profile] 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.

(no subject)

From: [personal profile] recessional - Date: 2019-01-19 11:55 pm (UTC) - Expand

(no subject)

Date: 2019-01-09 02:50 am (UTC)
kore: (Dreamwidth - green)
From: [personal profile] kore
Wow, v helpful! Thanks!

(no subject)

Date: 2019-01-09 03:46 am (UTC)
mdlbear: (hacker glider)
From: [personal profile] 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.)

(no subject)

Date: 2019-01-09 04:18 am (UTC)
cbrachyrhynchos: (Default)
From: [personal profile] cbrachyrhynchos
No, DW doesn't support code fences, and probably not most of the github/pandoc extensions.

(no subject)

From: [personal profile] mdlbear - Date: 2019-01-09 02:43 pm (UTC) - Expand

(no subject)

From: [personal profile] mdlbear - Date: 2019-01-10 12:09 am (UTC) - Expand

(no subject)

Date: 2019-01-09 06:53 am (UTC)
emceeaich: A close-up of a pair of cats-eye glasses (Default)
From: [personal profile] 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?

(no subject)

Date: 2019-01-09 07:06 am (UTC)
luzula: a Luzula pilosa, or hairy wood-rush (Default)
From: [personal profile] 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.

(no subject)

Date: 2019-01-09 07:57 am (UTC)
bluewinged_songbird: Steve Rogers with the caption "I'm not containable". (Steve Rogers)
From: [personal profile] bluewinged_songbird
Oh this is nice! Very concise and straightforward.

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

(no subject)

Date: 2019-01-09 12:16 pm (UTC)
From: [personal profile] raino
Thanks! This is super useful!

(no subject)

Date: 2019-01-09 03:55 pm (UTC)
replyhazy: (Default)
From: [personal profile] 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.

(no subject)

From: [personal profile] mdlbear - Date: 2019-01-10 12:21 am (UTC) - Expand

(no subject)

Date: 2019-01-11 06:28 am (UTC)
finch: (Default)
From: [personal profile] finch
Thank you for this! I'd picked up some of the markdown by osmosis but this actually makes it usably clear for me!

(no subject)

Date: 2019-01-11 12:42 pm (UTC)
swingandswirl: text 'tammy' in white on a blue background.  (Default)
From: [personal profile] swingandswirl
... you are WONDERFUL. /hands big basket of treat of choice/

/saves to Evernote/

(no subject)

Date: 2019-01-11 04:24 pm (UTC)
thedarlingone: Zaeed and Kasumi from Mass Effect (Default)
From: [personal profile] 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. ^_^)

(no subject)

Date: 2019-01-11 05:08 pm (UTC)
ligie: (Default)
From: [personal profile] ligie
It makes mobile posting so much easier. Thank you!

(no subject)

Date: 2019-01-11 09:28 pm (UTC)
applewoman: (Default)
From: [personal profile] applewoman
Thank you!! This is so helpful, especially since I use a markdown editor to write my posts already.

Re: Sorry for the late reply

From: [personal profile] applewoman - Date: 2019-01-30 03:01 am (UTC) - Expand

Re: Sorry for the late reply

From: [personal profile] applewoman - Date: 2019-01-31 05:34 pm (UTC) - Expand

(no subject)

Date: 2019-01-18 03:43 pm (UTC)
silveradept: A kodama with a trombone. The trombone is playing music, even though it is held in a rest position (Default)
From: [personal profile] 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.

Re: Happy to help

From: [personal profile] silveradept - Date: 2019-01-30 12:46 am (UTC) - Expand

(no subject)

Date: 2019-01-18 10:41 pm (UTC)
zenolalia: Lanque Bombyx in a field of purple flowers (Default)
From: [personal profile] zenolalia
Ah, fantastic! Thank you for letting us know about this rad feature!

(no subject)

Date: 2019-01-19 02:26 pm (UTC)
meicdon13: Close up of man's deadpan face with an excited caption "omg omg yay" (Excited)
From: [personal profile] meicdon13
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.

(no subject)

Date: 2019-01-19 03:01 pm (UTC)
goodbyebird: Comics: The Hulk is snuggling Spider-Woman. It's adorable. (C ∞ snuggles)
From: [personal profile] goodbyebird
Very useful, thanks!

(no subject)

Date: 2019-01-19 08:40 pm (UTC)
naraht: (Default)
From: [personal profile] naraht
Wow, this is really useful, thanks!

(no subject)

Date: 2019-01-20 02:18 am (UTC)
lovepeaceohana: Eggman doing the evil laugh, complete with evilly shining glasses. (Default)
From: [personal profile] lovepeaceohana
Oh my god, is markdown the reason fandom seems to have permanently adopted *** as page/scene separation marks?!

Re: This is a great question

From: [personal profile] peoriapeoriawhereart - Date: 2019-02-11 03:04 am (UTC) - Expand

(no subject)

Date: 2019-01-20 06:55 am (UTC)
genarti: Baby sloth looking over edge of cardboard box, with text "...duuuude." ([misc] duuuuuude)
From: [personal profile] genarti
Oh this is fascinating! I had no idea. Thanks so much for laying it out so clearly!

(no subject)

Date: 2019-01-21 06:49 pm (UTC)
sophus: (Default)
From: [personal profile] sophus
Oh, this is useful!

(no subject)

Date: 2019-01-22 02:23 am (UTC)
felinejumper: Janelle Monae in all white with black suspenders, holding a microphone (Default)
From: [personal profile] felinejumper
Holy SHIT I cannot believe the post editor accepts markdown THANK YOU THANK YOU THANK YOU.
Page 1 of 2 << [1] [2] >>

Hot Topics

February 2019

M T W T F S S
    123
45 678910
1112 131415 1617
18192021222324
25262728   

Style Credit

Expand Cut Tags

No cut tags

Subscription Filters

Page generated 2019-02-19 02:58 am
Powered by Dreamwidth Studios