DIMV
Blog Code About По-русски
DIMV

known-to-hugo

https://github.com/nekr0z/known-to-hugo/

A tool to help migrate the contents of your website to Hugo. Originally built to fetch contents from Known, later expanded to work with Google Plus, LiveJournal and Diary.ru.

The information below may be outdated. For the latest version, check the repository.

known-to-hugo

a little tool to help migrate your Known website to Hugo

Build Status codecov Go Report Card

Table of Contents

Help known-to-hugo get better!

Join the development (or just buy me a coffee, that helps, too).

Why

Known is great and has brought a lot of people to IndieWeb. However, its export features are incomplete and have bugs. If you want to start using Hugo instead, you need to get all your content from the Known instance and save it so that Hugo can work with it (a simple MySQL dump wouldn’t do). This tool here does exactly that.

How

Change the theme on your Known website to the builtin “Solo” theme (it may work with other themes, but no one has tested it yet). While your Known site is still up and running, open your command line and run the tool. It will try to save all your posts neatly to Hugo-compatible markdown files. It will also generate a JSON file with webmentions for every page that has them, as well as try to download the images.

Beware: the files will be overwritten without asking!

Command line options

1

-w [website]

the domain to look for, as in evgenykuznetsov.org or some-user.withknown.com or https://my-awesome-known-site.info.

1

-ww [path]

the part of website to try and download. Default is /content/posts, so only posts get downloaded. You can use -ww "" to download whatever content is listed on your home page, or -ww /content/all to try to get everything there is.

1

-p [directory]

the directory to save everything to. Default is known_website in your current directory.

1

-d

mark all the downloaded pages as drafts for Hugo.

1

-c [number]

number of pages to try to process simultaneously. Your server that runs Known might not like known-to-hugo’s attempt to download all the posts simultaneously (for example, the DreamHost shared web hosting I use starts serving 503s instead of pages when I try about 20 processes in parallel), so this option limits the number of pages processed in parallel. Default is 15.

Local backups processing

If you happen to have a local backup of your old blog, these are some experimental options for you:

1

-dir [path]

tells known-to-hugo to work with a local directory rather than a running website. The -w and -ww options are ignored in this case; site type (below) must be specified:

1

-type gplus

the local backup is Google Plus posts directory (as composed with Google Takeout), or

1

-type lj_backup

the local backup is a LiveJournal backup made with ljArchive, or

1

-type diary.ru

the local backup is a whole-site wget copy of a diary.ru-hosted blog.

Development

Pull requests are always welcome!

Credits

This software includes the following software or parts thereof:

Comments can be sent as webmentions or by email.