Home

Awesome

Forem.nvim

<p align="center">This plugin integrates Neovim with Forem platforms like [dev.to](https://dev.to)</p>

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

Dependencies

Required

Optional

Installation

Using lazy:

{
    "Massolari/forem.nvim",
    dependencies = {
        "nvim-lua/plenary.nvim",
        "nvim-telescope/telescope.nvim",
        "rcarriga/nvim-notify"
    }
}

Using packer:

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

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:

functioncommanddescription
feed():Forem feedShows fresh articles from the feed, then you can read it in Neovim or open it in the browser
my_articles():Forem my_articlesShows all your articles, then you can pick one to edit
new_article():Forem new_articleAsks for a title, then creates an article with the given title and open it to edit
open_by_url():Forem open_by_urlAsks 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