├── LICENSE ├── README.md └── gtd ├── inbox.norg ├── index.norg ├── programming.norg └── school.norg /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Neorg 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # example_workspaces 2 | 3 | This repository holds some example workspaces to let the user know how to use some modules in Neorg. 4 | 5 | ## How to use it 6 | 7 | Clone this repository: `git clone https://github.com/nvim-neorg/example_workspaces.git` 8 | 9 | ## Neorg GTD Tutorial 10 | 11 | To use the tutorial, create a new workspace in your config, pointing to the gtd directory, and add the workspace to GTD config: 12 | 13 | ```lua 14 | require("neorg").setup({ 15 | ["core.norg.dirman"] = { 16 | config = { 17 | workspaces = { 18 | example_gtd = "/path_where_you_cloned/example_workspaces/gtd", 19 | }, 20 | }, 21 | }, 22 | ["core.gtd.base"] = { 23 | config = { 24 | workspace = "example_gtd", 25 | }, 26 | }, 27 | }) 28 | ``` 29 | 30 | After that, just enter Neorg, and go to the workspace: `:Neorg workspace example_gtd` 31 | -------------------------------------------------------------------------------- /gtd/inbox.norg: -------------------------------------------------------------------------------- 1 | @document.meta 2 | title: inbox 3 | description: 4 | author: neorg-user 5 | categories: 6 | created: 2021-11-03 7 | version: 0.1 8 | @end 9 | 10 | -------------------------------------------------------------------------------- /gtd/index.norg: -------------------------------------------------------------------------------- 1 | @document.meta 2 | title: index 3 | description: This is a file containing a tutorial project for GTD users 4 | author: neorg-user 5 | categories: 6 | created: 2021-11-03 7 | version: 0.1 8 | @end 9 | 10 | * Meet GTD in Neorg 11 | This project shows you everything you need to know in order~ 12 | to get you running with GTD in Neorg. 13 | 14 | You can see the module details and configurations {https://github.com/nvim-neorg/neorg/wiki/Getting-Things-Done}[here] 15 | 16 | Don't hesitate to play around in it, you can always restart~ 17 | from scratch by doing: `:!git checkout %` (remove any change in this `index.norg` file) 18 | 19 | ** Grasp the basics 20 | - [ ] You can complete this todo by doing `gtd` (`gtu` to undone it) 21 | #contexts today 22 | - [ ] This is a todo in your today list 23 | > Want to see your today list ? Just do `:Neorg gtd views`, and press `t`. 24 | > To close the view, press `` 25 | 26 | - [ ] Plan this todo for later 27 | > Move the cursor on the task, and type `:Neorg gtd edit`. 28 | > You'll see a prompt asking you to modify the task. 29 | > Reschedule the todo for tomorrow by pressing `s`, and pressing `t`. Confirm with `` 30 | > Want to see your calendar ? Do `:Neorg gtd views`, and press `s`. 31 | 32 | #contexts home 33 | - [ ] This is a task with a context 34 | > A context is like a tag: it allows you to better categorize your tasks. 35 | > Some common contexts include `home`, `computer`, `errands`... 36 | > To add a context to the task, just write `#contexts your_context` on top of it 37 | > To see your contexts, do `:Neorg gtd views` and press `c`. 38 | 39 | - [ ] Create a new project 40 | > To create a new project, you can go at the end of the file (or any file in this workspace really). 41 | > Create a heading1 followed by the name of the project. (e.g `* This is a project`) 42 | > Everything inside it will be part of the project, and every task inside it too. 43 | 44 | - [ ] Organize with areas 45 | > Create an area for each sphere of your life, such as `Work`, `Family`... 46 | > To create an area, just place a Neorg marker, such as `| Work` 47 | > Areas of focus will divide projects in the project view: `Neorg gtd views`, and type `p` 48 | > (Want to know more about markers ? Go to: `:h neorg-markers`) 49 | > You can find some examples for areas of focus and project in these files:{:$/programming:}, {:$/school:} 50 | > Notice that you don't have to organize your tasks in different files like done here. 51 | > You can also keep everything in one big file or split it up even more. 52 | 53 | ** Tune your setup 54 | Now that the ground is here, we'll add shiny new things, to help you manage your GTD. 55 | By the way, you don't really know what GTD is? There's a great summary available {https://hamberg.no/gtd}[here] 56 | 57 | - [ ] Add your todos from anywhere in Neorg 58 | > To create a new task, you can do `:Neorg gtd capture` 59 | > You can even add contexts and dates, and select where the task will be captured ! 60 | 61 | - [ ] Go and see the inbox file 62 | > The `inbox` file is a special file in your gtd workspace, that can hold tasks and projects that are not processed. 63 | > Try going to the {:inbox:} file, and create a new task. When you're done, come back here. 64 | > You created the task ? Nice ! 65 | > To see all unprocessed tasks, go to `:Neorg gtd views` and press `u` (respectively, for projects: ``) 66 | 67 | ** One last thing... 68 | - [ ] Stay connected ! 69 | > Want to ask some questions about Neorg GTD? 70 | > Want to know about the latest features and developments? 71 | > You can join our Discord {https://discord.gg/xxZcYUJngw}[here] ! 72 | 73 | -------------------------------------------------------------------------------- /gtd/programming.norg: -------------------------------------------------------------------------------- 1 | @document.meta 2 | title: programming 3 | description: 4 | authors: random user 5 | categories: 6 | created: 2022-03-14 7 | version: 0.0.11 8 | @end 9 | 10 | | programming 11 | 12 | * Neorg 13 | - [ ] Indent engine 14 | - [_] Replicate emacs-org 15 | - [x] Great gtd 16 | 17 | * Neorg Telescope 18 | - [ ] More amazing pickers 19 | - [x] Picker to insert link 20 | #contexts today 21 | - [-] Gtd pickers 22 | 23 | * Neorg Zettelkasten 24 | #contexts home 25 | #waiting.for vhyrro 26 | - [ ] Write specs 27 | 28 | | _ 29 | -------------------------------------------------------------------------------- /gtd/school.norg: -------------------------------------------------------------------------------- 1 | @document.meta 2 | title: school 3 | description: 4 | authors: gtd-user 5 | categories: 6 | created: 2022-03-15 7 | version: 0.0.11 8 | @end 9 | 10 | | Uni 11 | 12 | * Computer science 13 | - [-] Watch the lecture from Professor Max again 14 | 15 | #contexts library 16 | - [ ] Read the book Professor Aloof recommended 17 | 18 | | _ 19 | 20 | | Doctor Paper 21 | 22 | #contexts university 23 | #waiting.for Professor Bob 24 | - [ ] discuss with supervisor 25 | 26 | * Research 27 | #contexts library 28 | - [x] Get the book "Chemistry inside computers" 29 | - [ ] finish reading book from Maxwell 30 | - [?] get more books 31 | - [!] summarize literature 32 | 33 | * Experiment 34 | #contexts laboratory 35 | - [x] Put the oil inside the computer 36 | - [ ] measure the oxygen content 37 | - [_] Do a second experiment with hydrogen 38 | - [ ] clean up 39 | 40 | #contexts library 41 | - [ ] compare results with the latest studies 42 | 43 | | _ 44 | --------------------------------------------------------------------------------