Giter Club home page Giter Club logo

forem.nvim's Introduction

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

  • View and edit your articles
  • Create a new article
  • View the feed of articles
  • View an article from the feed

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:

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

forem.nvim's People

Contributors

massolari avatar vinibispo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

vinibispo

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.