tumblr(5) -- tumblr posts in plaintext
======================================

## SYNOPSIS

	---
	title: A typical Tumblr post
	state: queue
	publish-on: next tuesday
	tags: unix, manpages
	format: markdown
	---
	
	This will create a *Regular* type of post on Tumblr.com. It's so easy. 
	That bit up at the top is called YAML frontmatter, and it just gives the 
	post a bit of metadata, so publishing options are more flexible.
	They correspond to the Tumblr API. This post will be added to your Tumblr 
	queue, to be published next Tuesday, tagged with "unix" and "manpages", 
	and formatted in markdown.
	
## DESCRIPTION

Any file can be published to Tumblr.com as a <i>Regular</i> post, but if you add a bit of YAML frontmatter (<yaml.org>) to the file, you can tell Tumblr exactly what you want to do.

YAML frontmatter beings with `---` on a single line, followed by YAML, ending with another `---` on a single line, e.g.

	---
	type: quote
	source: Billy Shakespeare
	state: draft
	tags: hamlet, shakespeare
	---
	"To be or not to be."
	
Understood YAML parameters are documented and taken from the Tumblr API: http://www.tumblr.com/docs/en/api#api_write

## BASIC PARAMETERS

These YAML parameters are available for all posts

* `type`:
	`regular`, `photo`, `link`, `quote`, `conversation`, `video`, `audio`
	Will take a guess if omitted.
	See _POST-TYPE SPECIFIC PARAMETERS_ below.

* `state`:
	`published`, `draft`, `queue`, `submission`
	
* `format`:
	`html` or `markdown`
	
* `tags`:	
	Comma-separated list of tags.
	
* `date`:
	Post date.
	
* `private`:
	If the post should be marked private.
	
* `slug`:
	A custom string to appear in the post's url.
	
* `group`:
	ID for a secondary blog.
	
* `generator`:
	Short description of the publishing application.
	
* `send-to-twitter`:
	Twitter status update to make if the tumblelog has enabled it.
	
* `publish-on`:	
	If the post state is 'queue', publish on this date
	
## POST-TYPE SPECIFIC PARAMETERS

These are parameters that are available for specific types of posts.

* `regular`:
	`title`
	
* `photo`:
	`caption`, `click-through-url`
	
* `quote`:
	`source`
	
* `link`:
	`name`, `description`
	
* `conversation`:
	`title`
	
* `video`:
	`title`,`caption`
	
* `audio`:
	`caption`
	
## SEE ALSO

tumblr(1), markdown(5)