breenbo / Norg-Tutorial

Norg tutorial with kickstart configuration.

Norg-Tutorial

Norg tutorial with kickstart configuration.

git clone https://github.com/pysan3/Norg-Tutorial.git
cd Norg-Tutorial/

📣 Big Caution ‼️‼️

Neorg just announced v3.0.0

The kickstart config is only compatible with v3.0.0+

Update the plugin if it is on an old version.

Before You Start

I recommend installing these documents.

• specifications.norg: https://github.com/nvim-neorg/norg-specs/blob/main/1.0-specification.norg
  • Complete document about the specifications of norg format.
  • wget https://raw.githubusercontent.com/nvim-neorg/norg-specs/main/1.0-specification.norg
  • No LICENSE
• neorg.norg: https://github.com/nvim-neorg/neorg/blob/main/doc/neorg.norg
  • Document about how to manipulate text. e.g. bold, italisize etc.
  • wget https://raw.githubusercontent.com/nvim-neorg/neorg/main/doc/neorg.norg
  • GPL v3.0

norg Tutorial

• ./norg_tutorial.norg
• ./norg_tutorial.md
  • Generated from ./norg_tutorial.norg. Might be inaccurate

I'd recommend you read ./norg_tutorial.norg on your local neovim with tree-sitter enabled but you can also read the conterved markdown on GitHub (which might be inaccurate).