Awesome Neorg

A collection of Neorg awesomeness, including config examples and inspo. Here's the thread where I kicked this here project off..

Contributions accepted delightedly! Throw up a Gist and submit a PR to this repo, adding a link to your gist (or whatever) to the README.md.

The Collection

Concealer Presets

Don't want to change each icon individually? Neorg has different presets to automate this for you. These presets don't exist only for icons, but for markup concealing too!

This snippet will set up your preferred icon or markup preset:

["core.norg.concealer"] = {
    config = {
        icon_preset = "basic|varied|diamond",
        markup_preset = "safe|brave|dimmed",
    }
}

Available Presets

Here are all the available icon presets:

basic - the default preset that neorg ships with:
varied - a mix n match of several different icon styles:
diamond - the neorg team's personal favourite! Diamonds, diamonds everywhere:

And here are all the available markup presets:

safe - a simple concealing implementation that converts all icons into whitespace. this doesn't modify the structure of your text but hides away all of the special characters:
brave - for the people who aren't scared of bugs. This implementation replaces all special characters with word joiners, which is known to work only on certain systems. Currently there is no easily controllable concealing in Neovim core, and it may take a while for it to be implemented:
dimmed - the default concealing method for Neorg. Dims your markup to make it more pleasant to look at:

FAQ

Wot's all this about?

Neorg is an org-mode-alike for Neovim.

And if you're wondering what that is about, then you're in for a treat :) Check out Neovim awesomeness here.

Who are you?

Just a software engineer, helping out of personal interest.

What's your relation to the Neorg project? the Neovim Project?

I'm basically a megafan of Neovim and most of its surrounding ecosystem, especially Neorg.

They said "be the change you want to see in the world," and I wanted to see more Neorg. Like, a lot more.

vhyrro / awesome-neorg