aPeoplesCalendar/apc.nvim

github github
utility
stars 20
issues 1
subscribers 2
forks 1
CREATED

2023-03-10

UPDATED

5 months ago


apc.nvim

AboutRequirementsInstallationConfigurationFeaturesContribute


This Neovim plugin is written in Lua and provides daily information from apeoplescalendar.org.

About

A People's Calendar (aPC) is a project that seeks to promote the worldwide history of working class movements and liberation struggles in the form of a searchable "On This Day" calendar.

This repository hosts the aPC neovim plugin, implemented in Lua.

This project is open source and the information contained in our event database is non-proprietary and will always be freely available for users, developers, and the public.

Requirements

Installation

Using lazy.nvim:

{
    "aPeoplesCalendar/apc.nvim",
    dependencies = {
        "rcarriga/nvim-notify",
    },
    event = "VeryLazy",
    config = function ()
        require("apeoplescalendar").setup() -- configuration options are described below
    end,
}

Configuration

apc.nvim comes with the following defaults:

{
    auto_teaser_filetypes = { "dashboard", "alpha", "starter", }, -- will enable running the teaser automatically for listed filetypes
}

Features

:APeoplesCalendar

Opens a new buffer showing today's events. In normal mode it can be closed with key q.

showcase for detailed event view

:APeoplesCalendarTeaser

Opens a popup with one randomly picked event for today's date. It disappears automatically after a few seconds.

showcase for teaser

Contribute

  • A People's Calendar is open source.
  • We are happy about feature requests, issue reports and code submissions
  • Commit messages must correspond to Conventional Commits