2 |
3 | 
4 |
5 | # [Neorg](https://github.com/nvim-neorg/neorg)Extras
6 |
7 | Neorg add-on to streamline organising your life in plain-text.
8 |
9 |
10 |
4 |
5 | # [Neorg](https://github.com/nvim-neorg/neorg)Extras
6 |
7 | Neorg add-on to streamline organising your life in plain-text.
8 |
9 |
11 |
12 |
13 |
14 | # System Prerequisites
15 |
16 | - ripgrep [`rg`](https://github.com/BurntSushi/ripgrep)
17 | - fd [`fd`](https://github.com/sharkdp/fd)
18 |
19 | # Installation
20 |
21 | This works alongside your [Neorg](https://github.com/andreadev-it/neorg-module-tutorials/blob/main/introduction.md#adding-it-to-neorg) installation.
22 |
23 | ## `lazy.nvim`
24 |
25 | ```lua
26 | return {
27 | "nvim-neorg/neorg",
28 | dependencies = {
29 | {
30 | "juniorsundar/neorg-extras",
31 | -- tag = "*" -- Always a safe bet to track current latest release
32 | },
33 | -- FOR Neorg-Roam Features
34 | --- OPTION 1: Telescope
35 | "nvim-telescope/telescope.nvim",
36 | "nvim-lua/plenary.nvim",
37 | -- OR OPTION 2: Fzf-Lua
38 | "ibhagwan/fzf-lua",
39 | -- OR OPTION 3: Snacks
40 | "folke/snacks.nvim"
41 | },
42 | config = function()
43 | require('neorg').setup({
44 | load = {
45 | -- MANDATORY
46 | ["external.many-mans"] = {
47 | config = {
48 | metadata_fold = true, -- If want @data property ... @end to fold
49 | code_fold = true, -- If want @code ... @end to fold
50 | }
51 | },
52 | -- OPTIONAL
53 | ["external.agenda"] = {
54 | config = {
55 | workspace = nil, -- or set to "tasks_workspace" to limit agenda search to just that workspace
56 | }
57 | },
58 | ["external.roam"] = {
59 | config = {
60 | fuzzy_finder = "Telescope", -- OR "Fzf" OR "Snacks". Defaults to "Telescope"
61 | fuzzy_backlinks = false, -- Set to "true" for backlinks in fuzzy finder instead of buffer
62 | roam_base_directory = "", -- Directory in current workspace to store roam nodes
63 | node_name_randomiser = false, -- Tokenise node name suffix for more randomisation
64 | node_name_snake_case = false, -- snake_case the names if node_name_randomiser = false
65 | }
66 | },
67 | }
68 | })
69 |
70 | -- I add this line here because I want to open
71 | -- up the default Neorg workspace whenever a Neovim instance
72 | -- is started
73 | require("neorg.core").modules.get_module("core.dirman").set_workspace("default")
74 | end
75 | }
76 | ```
77 |
78 | ## Others
79 |
80 | I don't use any other plugin managers. I haven't tested this with any others.
81 | If anyone happens to test it with `packer`, `rocks.nvim`, etc., please feel free
82 | to create a pull request.
83 |
84 | # [Neorg-Roam](./docs/neorg-roam.md)
85 |
86 | At the moment, this feature relies heavily on the a 3rd-Party Fuzzy Finder like
87 | ([Snacks.picker](https://github.com/folke/snacks.nvim),
88 | [Telescope](https://github.com/nvim-telescope/telescope.nvim) or
89 | [Fzf-Lua](https://github.com/ibhagwan/fzf-lua)).
90 | I have plans to liberate this plugin from this need, but that
91 | is something way down in the future after I have implemented the required basic
92 | features. So, for the moment, users of this plugin will have to bear with this
93 | dependency.
94 |
95 | Also note that there are a lot of similarities in this plugin with [`nvim-neorg/neorg-telescope`](https://github.com/nvim-neorg/neorg-telescope).
96 | It implements these features much better than I do, and more cleanly that I do.
97 | If you are comfortable using that, then you can install it along side this
98 | plugin and simply skip the Neorg-Roam feature-set.
99 |
100 | # [Neorg-Agenda](./docs/neorg-agenda.md)
101 |
102 | In order to organise your life in plain-text, you need to be able to open up
103 | your backlog of work... right? Neorg devs have a GTD system in their pipeline,
104 | but to create anything great you need to invest a lot of time. I am an
105 | inherently impatient person, so I decided to build something temporary that I
106 | can use in the meantime.
107 |
108 | ## Rationale
109 |
110 | I don't want to deviate excessively and create new grammar to accommodate my
111 | GTD because if, in the future, Neorg gains its own builtin GTD feature, I want
112 | to minimise issues of backwards compatibility. The last thing I want is to go
113 | through all my old files and remove artifacts that will interfere with the new
114 | and definitely superior GTD implementation.
115 |
116 | ## Views
117 |
118 | A new buffer that contains all the tasks in your workspace. Note that it will
119 | only consider tasks that are prefixed with a heading tag:
120 |
121 | ```norg
122 | * ( ) This task is recoginsed
123 |
124 | - ( ) This task is not ... yet
125 | ```
126 |
127 | So if you are someone who prefers to use a bullet based task listing strategy,
128 | this may not be the plugin for you.
129 |
130 | # To-Do
131 |
132 | ## Primary
133 |
134 | - [x] Deadline and time based scheduling
135 | - [x] Sorting by dates, tags, etc.
136 | - [x] Sorting by date and priority (default)
137 | - [x] Sorting by tags
138 | - [ ] Better UI for property tag population (especially dates and times)
139 | - [x] Wrapper around task changer to auto-generate property metadata
140 | - [ ] Alternate views (open to discussion)
141 | - [ ] Permalinking for Neorg-Roam
142 | - [x] Better UI for Backlinks (Telescope/Fuzzy finder is too distracting)
143 |
144 | ## Secondary
145 |
146 | - [ ] Generating graphs for organising tasks
147 | - [ ] Kanban?
148 |
--------------------------------------------------------------------------------
/doc/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/juniorsundar/neorg-extras/ec3fe9ef6c491e0e93306c427c6f5cc6b6a0d028/doc/.gitkeep
--------------------------------------------------------------------------------
/doc/neorg-agenda.txt:
--------------------------------------------------------------------------------
1 | *neorg-agenda.txt* For Last change: 2025 January 01
2 |
3 | ==============================================================================
4 | Table of Contents *neorg-agenda-table-of-contents*
5 |
6 | 1. Page View |neorg-agenda-page-view|
7 | 2. Day View (TM) |neorg-agenda-day-view-(tm)|
8 | 3. Tag View |neorg-agenda-tag-view|
9 | 4. The Property Metadata |neorg-agenda-the-property-metadata|
10 | 5. Sorting-out my Life |neorg-agenda-sorting-out-my-life|
11 | 6. Interactive Task Cycling |neorg-agenda-interactive-task-cycling|
12 | 7. Links |neorg-agenda-links|
13 |
14 | ==============================================================================
15 | 1. Page View *neorg-agenda-page-view*
16 |
17 | This will show all tasks filtered by the provided task states and turn it into
18 | a paginated view.
19 |
20 | `Neorg agenda page 12 |