README.md

Forem.nvim

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

Gravacao.de.Tela.2022-06-25.as.00.01.26.mov

Gravacao.de.Tela.2022-06-25.as.00.04.27.mov

Summary

• Features
• Dependencies
  • Required
  • Optional
• Installation
• Setup
• Usage
• Contributing
• 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
• Telescope

Optional

• Notify

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:

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