Skip to content

Displaying News

github-actions[bot] edited this page Jun 25, 2022 · 214 revisions

Seeing The Latest Neorg News at Your Fingertips

Handles the displaying of Neorg news and other forms of media in a popup.

Overview

Usage

How to Apply

  • This module is already present in the core.defaults metamodule. You can load the module with:
    ["core.defaults"] = {},
    In your Neorg setup.
  • To manually load the module, place this code in your Neorg setup:
    ["core.norg.news"] = {
       config = { -- Note that this table is optional and doesn't need to be provided
           -- Configuration here
       }
    }
    Consult the configuration section to see how you can configure core.norg.news to your liking.

Configuration

Developer Usage

Public API

This segment will detail all of the functions core.norg.news exposes. All of these functions reside in the public table.

  • create_display
  • get_content

Examples

None Provided

Extra Info

Version

This module supports at least version 0.0.11. The current Neorg version is 0.0.11.

Imports

This module does not import any other files.

Requires

  • core.ui - A set of public functions to help developers create and manage UI (selection popups, prompts...) in their modules.
  • core.storage - Deals with storing persistent data across Neorg sessions.
  • core.neorgcmd - This module deals with handling everything related to the :Neorg command.

Required by

This module isn't required by any other module.