https://github.com/sealjay/ghost-to-mdx
A tool to migrate Ghost export files and associated images to an MDX format.
https://github.com/sealjay/ghost-to-mdx
Last synced: 3 months ago
JSON representation
A tool to migrate Ghost export files and associated images to an MDX format.
- Host: GitHub
- URL: https://github.com/sealjay/ghost-to-mdx
- Owner: Sealjay
- License: mit
- Created: 2022-09-27T12:33:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-20T17:14:48.000Z (about 1 year ago)
- Last Synced: 2025-01-28T04:45:53.774Z (4 months ago)
- Language: Python
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ghost-to-mdx
> A tool to convert Ghost export files to a series of .MDX files.
[](http://commitizen.github.io/cz-cli/)
[](https://www.python.org/)
## Overview
Ghost is an incredible project, but it's very expensive to run, with overhead for single user blogs. As Ghost develops over time, it's adding a lot of extra functionality around things like email subscriptions, and newsletters.
For some people, this functionality is too much.
This project is a tool to convert your Ghost export file into a series of .MDX files, which can be used with a static site generator, to be deployed to an [Azure Static Web App](https://docs.microsoft.com/en-us/azure/static-web-apps/deploy-nextjs?WT.mc_id=AI-MVP-5004204); reducing cost and maintenance complexity.
## Licensing
ghost-to-mdx is available under the [MIT Licence](./LICENCE).and is freely available to End Users.
## Solutions Referenced
- [Azure Static Web App](https://docs.microsoft.com/en-us/azure/static-web-apps/deploy-nextjs?WT.mc_id=AI-MVP-5004204)
- [Azure Static Web App CLI](https://learn.microsoft.com/en-us/azure/developer/javascript/how-to/with-web-app/static-web-app-with-swa-cli/introduction?WT.mc_id=AI-MVP-5004204)
## Getting started with this repository
You can use a [dev container](https://docs.microsoft.com/en-us/azure-sphere/app-development/container-build-vscode?&WT.mc_id=AI-MVP-500420) to run this in VS Code, or in [GitHub codespaces](https://github.com/features/codespaces).
### Downloading the Ghost export file
1. Login to your Ghost admin panel.
2. Go to your settings page.
3. Go to the "Labs" tab.
4. Click "Export Content".
5. Download the file.
6. Save the file as `export.json` in the `data` folder.
### Install the required python dependencies
This project uses Conda for managing dependencies, but you can use the requirements.txt file to install the dependencies using pip.
1. Update conda: `conda update conda`
2. Create the environment (Call it ghosttomdx) `conda create -c conda-forge -n ghosttomdx python=3.10 pip`
3. Activate the environment: `source activate ghosttomdx`
4. Install all required packages: `pip install -r requirements.txt`.
5. Get some space back: `conda clean -a`
### Run the python application
- `convert_ghost_to_html.py` will export flat-file HTML for posts and pages, along with metadata in YAML files.
- `convert_ghost_to_mdx.py` will export MDX and HTML suitable for use in a NextJS static site.
### Points to note
- Your images will remain wherever you have them mouned in storage, and you will need to copy them to a new location or CDN in your project.
### Modifying the templates
MDX templates are found in the `data` folder, and follow the examples on the [NextJS](https://nextjs.org/docs/advanced-features/using-mdx) website.
## Contact
Feel free to contact me [on Twitter](https://twitter.com/sealjay_clj). For bugs, please [raise an issue on GitHub](https://github.com/Sealjay/ghost-to-mdx/issue).
## Contributing
Contributions are more than welcome! This repository uses [GitHub flow](https://guides.github.com/introduction/flow/) - with [Commitizen](https://github.com/commitizen/cz-cli#making-your-repo-commitizen-friendly) to enforce semantic commits (`npm install -g commitizen cz-customizable`, `echo '{ "path": "cz-customizable" }' > ~/.czrc`, and then `git cz`- easy to setup!)
**Note: This adds a .czrc file to your home directory, and will overwrite existing commitzen .czrc files.**