Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eugenehp/gatsby-source-medium-backup
Gatsby plugin to import your medium posts from a backup as markdown files.
https://github.com/eugenehp/gatsby-source-medium-backup
gatsby gatsby-plugin import medium reactivelions source
Last synced: about 1 month ago
JSON representation
Gatsby plugin to import your medium posts from a backup as markdown files.
- Host: GitHub
- URL: https://github.com/eugenehp/gatsby-source-medium-backup
- Owner: eugenehp
- License: mit
- Created: 2021-04-09T03:21:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-06-26T04:50:21.000Z (over 3 years ago)
- Last Synced: 2024-09-30T10:01:24.581Z (about 1 month ago)
- Topics: gatsby, gatsby-plugin, import, medium, reactivelions, source
- Language: JavaScript
- Homepage: https://github.com/eugenehp/gatsby-source-medium-backup#readme
- Size: 542 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# gatsby-source-medium-backup
[](./LICENSE)
[](https://www.npmjs.com/package/gatsby-source-medium-backup)
[](https://npmcharts.com/compare/gatsby-source-medium-backup?minimal=true)
[](https://npmcharts.com/compare/gatsby-source-medium-backup?minimal=true)
[](https://github.com/eugenehp/gatsby-source-medium-backup/watchers)
[](https://github.com/eugenehp/gatsby-source-medium-backup/stargazers)
[](https://github.com/eugenehp/gatsby-source-medium-backup/network/members)
[](https://github.com/eugenehp/gatsby-source-medium-backup/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Abug)
[](https://github.com/eugenehp/gatsby-source-medium-backup/issues)
[](https://github.com/eugenehp/gatsby-source-medium-backup/pulls)
[](https://packagephobia.com/result?p=gatsby-source-medium-backup)
[](https://bundlephobia.com/[email protected])
Gatsby plugin to import your medium posts from a backup as markdown files.
## Installation
We assume you've already [created gatsby website](https://www.gatsbyjs.com/docs/tutorial/part-zero/#create-a-gatsby-site) using command like this:
```shell
gatsby new example https://github.com/gatsbyjs/gatsby-starter-hello-world
```
### Install dependencies
```shell
cd example
npm i -s gatsby-source-filesystem gatsby-transformer-remark gatsby-source-medium-backup
```
### Configure your gatsby plugins
Go to `gatsby-config.js` and configure folder for your processed markdown pages first:
```javascript
const markdownPages = `${__dirname}/src/markdown-pages`
```
Then inside the `plugins` section add `gatsby-source-medium-backup` first and specify location of your medium backfile inside `source`:
```javascript
{
resolve: 'gatsby-source-medium-backup',
options: {
source: `${__dirname}/medium-export.zip`,
destination: markdownPages,
},
},
```
Add markdown generation **after** above plugin!
```javascript
// markdown
{
resolve: `gatsby-source-filesystem`,
options: {
path: markdownPages,
name: `markdown-pages`,
//prefix: 'blog' // optional: prefix all slugs
h1h2: true, // optional: convert all h3 and h4 to h1 and h2
// h2h3: true, // optional: convert all h3 and h4 to h2 and h3
},
},
`gatsby-transformer-remark`,
```
### Download your medium archive
[Here](https://help.medium.com/hc/en-us/articles/115004745787-Download-your-information)'s official guide from Medium.
1. On your homepage, click on your profile picture and click Settings.
2. Scroll down to the Download your information section.
3. Click Download . zip and confirm by clicking Export.
4. A link to download your archive will be sent to you by email when it is finished.
### Configure your gatsby blog posts generation
This section essentially follows original guideline for adding markdown pages [here](https://www.gatsbyjs.com/docs/how-to/routing/adding-markdown-pages/)
1. Create [`./src/templates/blogTemplate.js`](./src/templates/blogTemplate.js), which will be used as a page template for your blog posts.
2. Configure your [`./gatsby-node.js`](./gatsby-node.js) to generate blog posts using markdown files during the build time.
### Now run your gatsby
```shell
cd example
gatsby develop
```
Navigate to [http://localhost:8000/404](http://localhost:8000/404) and you'll see your markdown pages generated.
## Troubleshooting
1. Make sure to put absolute path for your medium archive.
2. This plugin generate following metadata for each post:
```json
{
"title": "How to build a react-native plugin in 2021",
"author": "Eugene Hauptmann",
"authorLink": "https://medium.com/@eugenehauptmann",
"canonical": "https://medium.com/@eugenehauptmann/how-to-build-a-react-native-plugin-in-2021-60704edc0c28",
"timestamp": "2021-04-06T00:58:51.984Z",
"exportDate": "April 6, 2021"
}
```
## Sponsorship
Thank you to our sponsors:
[
](https://www.reactivelions.com)
## License
[MIT](./LICENSE)
Copyright (c) 2021 Eugene Hauptmann