https://github.com/charles-m-knox/ghost-to-hugo
Takes Ghost blog posts and converts them to Hugo-compatible markdown files.
https://github.com/charles-m-knox/ghost-to-hugo
ghost ghost-blog go golang hugo markdown sql synchronize synchronizer
Last synced: over 1 year ago
JSON representation
Takes Ghost blog posts and converts them to Hugo-compatible markdown files.
- Host: GitHub
- URL: https://github.com/charles-m-knox/ghost-to-hugo
- Owner: charles-m-knox
- License: agpl-3.0
- Created: 2024-09-09T02:35:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T03:01:06.000Z (almost 2 years ago)
- Last Synced: 2025-02-18T19:30:30.898Z (over 1 year ago)
- Topics: ghost, ghost-blog, go, golang, hugo, markdown, sql, synchronize, synchronizer
- Language: Go
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ghost-to-hugo
Takes Ghost blog posts and converts them to Hugo-compatible markdown files.
This leverages a database connection - Ghost recommends mysql as its supported database type, but it can technically work with any compliant driver that implements Go's `database/sql` interfaces.
This is compatible with **Ghost v5.87.1**. Compatibility with any other version is not guaranteed.
## Requirements
The only specific requirement is that your Hugo project *must* support some kind of raw HTML shortcode, such as:
`themes/your-theme/layouts/shortcodes/rawhtml.html`
```text
{{ .Inner }}
```
This is necessary because the raw HTML from Ghost has to be placed somewhere in the rendered Hugo Markdown files.
If your shortcode is called something else, you can define a custom shortcode in the config using `RawShortcodeStart` and `RawShortcodeEnd`.
## Example Usage
See [`examples/simple/README.md`](./examples/simple/README.md).
## Warnings
**Please verify the output of this application before publishing it**. If your configuration is incorrect, it may publish premium content from your Ghost instance to the world, or it may publish newsletters as posts.
## Features
- Supports replacing all instances of `__GHOST_URL__` (which is what Ghost uses) with your own string, see `GhostURL` in the config
- Parses every HTML XML node and does the following:
- removes all `height` and `width` values from `![]()
` tags, because Ghost assigns weird values for these
- optionally can replace specific strings found in all `` tags' `href` attributes, such as replacing `example.com` with `nojs.example.com` (see `LinkReplacements` in the config)
- Can choose to ignore publish/draft state and publish all posts - see `PublishDrafts` in the config
- Set `SetUnpublishedToNow` to `true` in the config to force any unpublished documents to be rendered (decrements post time by one second for each post without a publish date)
- Can apply basic filters via post status, visiblities, and types (see `PostTypes`, `PostStatuses`, `PostVisibilities` mappings in the config)
- Set `ForbidEmptyPosts` in the config to halt the program if any empty (null) posts are encountered
## Motivation
Ghost is an incredible project that has empowered myself and others in my community to achieve higher productivity with digital content marketing online.
However, Ghost is very JavaScript-heavy. In my browser, Ghost admin/blog post pages can use up to 200MB RAM per tab. I personally like to use less RAM if possible.
I wanted an option to use both Ghost and statically rendered Markdown files that work with Hugo. A browser tab using a barebones Hugo theme can use between 20-30MB RAM, almost 10% of what the Ghost-equivalent uses.
The idea is to run `ghost-to-hugo` on a regular basis, such as once per day or hour, and then serve the Hugo-rendered content from e.g. `https://nojs.example.com`, whilst simultaneously serving your Ghost-powered content at `https://example.com`.
## Structure
In order to keep dependencies to zero (see [`go.mod`](./go.mod) - it only uses the standard library), this Go module is structured as a library that can be imported by any application.
This has the benefit of not requiring any specific SQL driver - it accepts SQL rows themselves from the `database/sql` package. You can use any compliant driver, such as sqlite or postgres - although I haven't tried anything aside from mysql, so tread carefully.
## Other notes
There may be other hidden capabilities in this that I've not documented or explored fully. For example, it *may* be possible to get creative with templates to support rendering the featured image for a post (the default template does not support this currently).
`.json` files are used for configuration because I do not want to pull in larger dependencies like `yaml`.
## Development notes
The `ghosttohugo` package is the primary library for this module. Its unit test coverage is currently at **`70.7%`** and at this time, I do not intend to get it higher. The core business logic is well-tested; everything else remaining is not worth unit testing.
## Compatibility
Here is a list of all tested Ghost versions that are known to work:
- v5.87.1
The only table that needs to be read from the database is the `posts` table. If any database migrations occur upstream, this application will likely break.