https://github.com/nvim-neorg/example_workspaces

https://github.com/nvim-neorg/example_workspaces

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/nvim-neorg/example_workspaces
• Owner: nvim-neorg
• License: mit
• Created: 2021-11-03T12:07:08.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-10-20T00:35:12.000Z (over 3 years ago)
• Last Synced: 2025-01-09T08:12:33.811Z (over 1 year ago)
• Size: 8.79 KB
• Stars: 21
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# example_workspaces

This repository holds some example workspaces to let the user know how to use some modules in Neorg.

## How to use it

Clone this repository: `git clone https://github.com/nvim-neorg/example_workspaces.git`

## Neorg GTD Tutorial

To use the tutorial, create a new workspace in your config, pointing to the gtd directory, and add the workspace to GTD config:

```lua

require("neorg").setup({

    ["core.norg.dirman"] = {

      config = {

        workspaces = {

          example_gtd = "/path_where_you_cloned/example_workspaces/gtd",

        },

      },

    },

    ["core.gtd.base"] = {

      config = {

        workspace = "example_gtd",

      },

    },

})

```

After that, just enter Neorg, and go to the workspace: `:Neorg workspace example_gtd`