Skip to content

Latest commit

 

History

History
73 lines (40 loc) · 1.94 KB

README.md

File metadata and controls

73 lines (40 loc) · 1.94 KB

Retumble

Build Tumblr themes with React. Test them on localhost.

NOTE: this is very much an experiment. It works, but run any mission-critical blogs at your own risk

Getting started

Install

npm -g i retumble

Or clone this repo, and npm link it.

Create a new theme

retumble init tumblr-react-new
cd tumblr-react-new
npm install

This creates a new project called project. Ez.

Test a theme locally

retumble run

When ran from the root of the project, this will load data from a default sample blog. To use custom test data, use

retumble run --source http://<some retumble blog>.tumblr.com/

Where <some retumble blog> is a Tumblr blog that is using a retumble theme. No, if you point it at just some random blog this wont work; the blog needs to be running a retumble theme.

Use a theme on tumblr.com/customize

retumble ready | pbcopy

(pbcopy works on macOS. Use linux/window's own clipboard commands if that's what you're on)

The ready command will dump the bundled theme HTML. Paste this as "custom html" in tumblr.com/customize as you would with any other theme file.

Writing a theme

Coming soon!

Extras

There's a few cool extras I implement so you don't have to.

  • Infinite Scrolling
  • A drawer for notes
  • Resizable music player

Documentation coming I guess? You can also check the auto-generated project built with retumble init to check out usage.

Limitations

Of course, being the first release adding react on top of what's already a kind of hacky themeing situation, there are certain limitations. At the moment:

Actions are unsupported

Reblog, Like, etc.

Not all tumblr "theme tags" are incorporated

More will be coming, open an issue if you have any requests

Bugs

Open an issue!