https://github.com/thealoneprogrammer/medium-articles
An unofficial package for getting medium articles of an account.
https://github.com/thealoneprogrammer/medium-articles
get-medium-posts medium medium-api medium-article medium-json medium-posts
Last synced: 4 months ago
JSON representation
An unofficial package for getting medium articles of an account.
- Host: GitHub
- URL: https://github.com/thealoneprogrammer/medium-articles
- Owner: thealoneprogrammer
- Created: 2021-05-13T17:38:21.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-15T16:46:24.000Z (about 4 years ago)
- Last Synced: 2024-04-24T20:42:15.369Z (about 1 year ago)
- Topics: get-medium-posts, medium, medium-api, medium-article, medium-json, medium-posts
- Language: TypeScript
- Homepage: https://thealoneprogrammer.github.io/medium-articles/
- Size: 1.23 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## **medium-articles**
> **Get Medium posts of an account in JSON format**
medium-articles is an unofficial package for getting medium posts of an account.
## **Install**
```sh
$ npm install medium-articles
OR
$ yarn add medium-articles
```
This module uses [rss-parser](https://www.npmjs.com/package/rss-parser) under the hood to work.
## **Usage with ES6**
```js
import { getMediumPosts } from 'medium-articles'
const username = "your medium account username"
async () => {
// This will give you all of your medium posts in JSON format.
const articles = await getMediumPosts(username)
...
}
```
## **Node Js usage**
```js
const getMediumPosts = require('medium-articles')
const username = "your medium account username"
async () => {
// This will give you all of your medium posts in JSON format.
const articles = await getMediumPosts(username)
...
}
```
## **Allowed username format**
1. username //example - vue
2. @username //example - @vue
## **Development**
Install packages
```sh
$ npm install
```
Build
```sh
$ npm run build
```
Test
```sh
$ npm run test
```