Skip to content

feat: add a self-contained launcher with flake.nix #1775

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
champignoom wants to merge 1 commit into
base: main
Choose a base branch
from
+411 −0
Open

feat: add a self-contained launcher with flake.nix #1775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,17 @@ Neorg's setup process is slightly more complex than average, so we encourage you
installation process, run `:checkhealth neorg` to see if everything's
correct!**

### nix one-liner

If you have [nix](https://nixos.org/) with [flakes](https://nixos.wiki/wiki/Flakes) enabled, you can try neorg in one line:

`nix run 'github:nvim-neorg/neorg?dir=flake-app'`

It opens a self-contained neorg bundled with xterm, fonts, colorscheme and other basic configurations,
so that you can try neorg with zero hassle.

It opens the default neorg workspace under `~/neorg-notes`. Copy and modify `flake-app/flake.nix` if you want to change the path.

### `neorg-kickstart`

Not bothered to set up Neovim on your own? Check out our [kickstart config](https://github.com/nvim-neorg/neorg/wiki/Kickstart)
Expand Down
241 changes: 241 additions & 0 deletions flake-app/flake.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading