jekyll-to-hugo/readme.md
Denis-Cosmin NUTIU b461cef694 update readme.md
2023-06-03 16:09:43 +03:00

1.8 KiB

Jekyll to Hugo Converter

Jekyll to Hugo Converter is a simple tool to convert Jekyll posts to Hugo posts.

I've used this tool to convert my blog from WorPress to Jekyll to Hugo.

Note: This tool is not perfect, it will not convert everything. If you find a bug, please open a PR.

Table of Contents

Usage

PiPy or Pipx

If you have Python installed, you can use the following commands:

pip install jekyll-to-hugo
jekyll-to-hugo

You will need to create a config.yaml file in the current directory. See example here.

pipx is a tool to install Python CLI tools in isolated environments

Python From Source

If you have Python installed, you can use the following commands:

pip install -r requirements.txt
python3 jekyll-to-hugo.py <jekyll_post_path> <hugo_post_path>

To change the config, edit config.yaml.

The configuration file path can be configured with the CONFIG_PATH environment variable.

Docker

If you don't have Python installed, you can use Docker:

  1. Build the image.
docker build -t jekyll-to-hugo .
  1. Run the image. You will need to mount the following directories: config file, Jekyll posts directory, Hugo posts directory.
docker run -it --rm -v $(pwd):/app jekyll-to-hugo

Configuration

The configuration file is a YAML file. See example here. The configuration file path can be configured with the CONFIG_PATH environment variable.

License

This project is licensed under the GPL-3.0 license - see the LICENSE file for details.


Made with ❤️ by NucuLabs.dev