https://github.com/madskjeldgaard/neorg-figlet-module

Easily use Figlet in Neorg
https://github.com/madskjeldgaard/neorg-figlet-module

neorg neorg-module

Last synced: 3 months ago
JSON representation

Easily use Figlet in Neorg

• Host: GitHub
• URL: https://github.com/madskjeldgaard/neorg-figlet-module
• Owner: madskjeldgaard
• Created: 2023-07-06T15:35:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-27T10:56:59.000Z (10 months ago)
• Last Synced: 2024-04-04T12:32:39.148Z (7 months ago)
• Topics: neorg, neorg-module
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-neorg - neorg-figlet-module - Figlet integration for Neorg (Integrations)

README

        
# A Figlet module for Neorg

This is a small plugin / module for [Neorg](https://github.com/nvim-neorg/neorg), making it possible to easily insert figlet text in a document.

## Installation

Install using packer:

```lua

use "madskjeldgaard/neorg-figlet-module"

```

## Configuration

In the `load` section of your neorg module, as a minimum add `["external.integrations.figlet"] = {}`, and fill out the config options:

```lua

require('neorg').setup({

	load = {

		["external.integrations.figlet"] = {

			config = {

				font = "doom",

				wrapInCodeTags = true

			}

		},

		["core.defaults"] = {}, -- Loads default behaviour

...

    })

```

This will expose a keymap to the `keymap` part of your neorg setup. Use it like this:

```lua

-- Prompt for text and insert as figletized

keybinds.map("norg", "n", "ff",

    "Neorg keybind norg external.integrations.figlet.figletize")

```