DEV Community

Cover image for Introducing Papertown
Christian Kohler
Christian Kohler

Posted on • Updated on • Originally published at

Introducing Papertown

Papertown syncs you personal markdown blog with blog platforms like It's a command line tool and works perfectly in combination with static blog frameworks like Gatsby.

The idea 💡

The core idea of Papertown is that it runs on every commit and creates and updates blogpost on and other platforms.

// Current setup
+-----------+       +-----------+        +-----------+
| Commit md |  ---> |  Gatsby   |  --->  |  Webhost  |
+-----------+       +-----------+        +-----------+
// With Papertown

                    +-----------+        +-----------+
                  / |  Gatsby   |  --->  |  Webhost  |
+-----------+    /  +-----------+        +-----------+
| Commit md |
+-----------+    \  +-----------+        +-----------+
                  \ | Papertown |  --->  | devto etc |
                    +-----------+        +-----------+

Why did I write it? 📝

I had two requirements for my personal blog:

✅ Blog content is owned and managed by me

✅ I want to syndicate my post on other platforms as easy as possible

How to use it 🚀

The easiest way to get started is to just run it locally with npx within you blog root folder:

npx papertown sync --devtoApiKey apikey

Don't worry, no blogpost are pushed to unless you add a masterid to a blogpost


Papertown needs an Id to identify blogpost and update them. Blogpost without a masterid are ignored.

title: "Minimal Blogpost example frontmatter"
author: "Chris Kohler"
masterid: 20191109
published: false
canonical_url: ""

Draft or published?

Add published: false if you don't want to publish the blogpost right now.

published: false

Correct root folder

The default rootfolder is blog-articles. To change it just set the root folder:

papertown sync --rootFolder posts

Alternatives to Papertown 🔭

There are two solutions I know of:

RSS feed support by

RSS feed support is not bad but is not as flexibel as I'd wish for updates and drafts.

Use as a source together with Gastby as a source is not an option for me since I want to be the master of the blog articles.

Source 👨‍💻

Source is MIT and on Github:

What's next? 👀

Over the next weeks I will focus on the integration and fixing bugs. The highest prioritiy currently is adding support for images. After that I will start to work on the medium integration. If you would like to help please open an issue or pr on Github. All contributions are appreciated.


Version 1.2.0 comes with image support. That means that relative urls are now converted to github raw urls.

Top comments (0)