https://github.com/dnutiu/jekyll-to-hugo
Convert jekyll markdown files to Hugo markdown files with this easy and simple to use Python script
https://github.com/dnutiu/jekyll-to-hugo
converter hugo jekyll static-site wordpress
Last synced: 4 months ago
JSON representation
Convert jekyll markdown files to Hugo markdown files with this easy and simple to use Python script
- Host: GitHub
- URL: https://github.com/dnutiu/jekyll-to-hugo
- Owner: dnutiu
- License: gpl-3.0
- Created: 2023-05-29T17:54:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-07-12T21:38:38.000Z (11 months ago)
- Last Synced: 2025-09-25T15:15:23.526Z (9 months ago)
- Topics: converter, hugo, jekyll, static-site, wordpress
- Language: Python
- Homepage:
- Size: 200 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://blog.nuculabs.dev) from WordPress to Jekyll and finally to Hugo.
The tool has the following features:
- Batch conversion.
- Post header fields drop/ignore.
- Links rewrite. (Search and Replace)
- Author name rewrite.
It was written in a way that is easy to extend, while I wrote it for my own personal use, I hope you'll find some use for it as well.
Note: This tool is not perfect, it will not convert everything. If you find a bug, please open a PR.
## Table of Contents
* [Usage](#usage)
* [PiPy](#pipy)
* [Python From Source](#python-from-source)
* [Docker](#docker)
* [Configuration](#configuration)
* [Example Configuration](#example-configuration)
* [License](#license)
## Usage
### PiPy or Pipx
If you have Python installed, you can use the following commands:
```bash
pip install jekyll-to-hugo
jekyll-to-hugo
```
You will need to create a `config.yaml` file in the current directory. See example [here](./config.yaml).
_`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:
```bash
pip install -r requirements.txt
python3 jekyll-to-hugo.py
```
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.
```bash
docker build -t jekyll-to-hugo -f ./docker/Dockerfile .
```
2. Run the image. You will need to mount the following directories: config file, Jekyll posts directory, Hugo posts directory.
```bash
docker run -it --rm -v $(pwd):/app jekyll-to-hugo
```
## Configuration
The configuration file is a YAML file. See example [here](./config.yaml).
The configuration file path can be configured with the `CONFIG_PATH` environment variable.
### Example Configuration
```yaml
logging_level: "INFO"
source_path: "/Users/dnutiu/PycharmProjects/jekyll-to-hugo/my_test_data/_posts"
output_path: "/Users/dnutiu/NucuLabsProjects/NucuLabsDevBlog/content/posts"
converter: "wordpress_markdown_converter"
converter_options:
enable_regex_heuristics: true
author_rewrite: "Denis Nuțiu"
links_rewrite:
- source: "http://localhost/"
target: "/"
- source: "https://nuculabs.wordpress.com/"
target: "https://nuculabs.dev/posts/"
- source: "https://twitter.com/metonymyqt"
target: "https://twitter.com/nuculabs"
header_fields_drop:
- restapi_import_id
- original_post_id
- timeline_notification
- wordads_ufa
- spay_email
- amp_status
- advanced_seo_description
- publicize_twitter_user
```
## License
This project is licensed under the GPL-3.0 license - see the [LICENSE](LICENSE) file for details.
---
Made with ❤️ by [NucuLabs](https://blog.nuculabs.dev)