https://github.com/Massolari/forem.nvim

Neovim plugin to read, write and post articles on Forem platforms like dev.to
https://github.com/Massolari/forem.nvim

fennel forem neovim plugin vim

Last synced: about 2 months ago
JSON representation

Neovim plugin to read, write and post articles on Forem platforms like dev.to

• Host: GitHub
• URL: https://github.com/Massolari/forem.nvim
• Owner: Massolari
• License: mit
• Created: 2022-06-22T20:04:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-15T13:29:48.000Z (7 months ago)
• Last Synced: 2024-05-05T15:37:19.835Z (5 months ago)
• Topics: fennel, forem, neovim, plugin, vim
• Language: Lua
• Homepage:
• Size: 174 KB
• Stars: 18
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Forem.nvim

This plugin integrates Neovim with Forem platforms like [dev.to](https://dev.to)


https://user-images.githubusercontent.com/12272702/175755820-a2b93f4b-fd5c-416b-8b9e-d981335ef75c.mov

https://user-images.githubusercontent.com/12272702/175755866-62be0b6c-31b2-4f45-81c7-f30cd3301d43.mov

## Summary

- [Features](#features)

- [Dependencies](#dependencies)

  - [Required](#required)

  - [Optional](#optional)

- [Installation](#installation)

- [Setup](#setup)

- [Usage](#usage)

- [Contributing](#contributing)

- [Credits](#credits)

## Features

- View and edit your articles

- Create a new article

- View the feed of articles

- View an article from the feed

## Dependencies

### Required

- [Plenary](https://github.com/nvim-lua/plenary.nvim)

- [Telescope](https://github.com/nvim-telescope/telescope.nvim)

### Optional

- [Notify](https://github.com/rcarriga/nvim-notify)

## Installation

### Using [lazy](https://github.com/folke/lazy.nvim):

```lua

{

    "Massolari/forem.nvim",

    dependencies = {

        "nvim-lua/plenary.nvim",

        "nvim-telescope/telescope.nvim",

        "rcarriga/nvim-notify"

    }

}

```

### Using [packer](https://github.com/wbthomason/packer.nvim):

```lua

use {

    "Massolari/forem.nvim",

    requires = {

        "nvim-lua/plenary.nvim",

        "nvim-telescope/telescope.nvim",

        "rcarriga/nvim-notify"

    }

}

```

## Setup

> [!NOTE]

> These instructions are for the dev.to platform.

First, you need to generate an API key for the DEV platform.

For dev.to, you can do it in [the end of the extension's page](https://dev.to/settings/extensions)

With your API key, you just need to set it into the `FOREM_API_KEY` environment variable.

## Usage

The plugin has the following commands and functions available in `forem-nvim` module:

| function        | command              | description                                                                                  |

| --------------- | -------------------- | -------------------------------------------------------------------------------------------- |

| `feed()`        | `:Forem feed`        | Shows fresh articles from the feed, then you can read it in Neovim or open it in the browser |

| `my_articles()` | `:Forem my_articles` | Shows all your articles, then you can pick one to edit                                       |

| `new_article()` | `:Forem new_article` | Asks for a title, then creates an article with the given title and open it to edit           |

| `open_by_url()` | `:Forem open_by_url` | Asks for a URL, then opens the article                                                       |

After you save the buffer it'll automatically be saved in the cloud.

## Contributing

Please, don't hesitate in contributing by creating issues and opening pull requests.

## Credits

This plugin design and idea was inspired by [octo.nvim](https://github.com/pwntester/octo.nvim)