Skip to content

Modular Emacs configuration amenable to collaboration!

Notifications You must be signed in to change notification settings

gvoysey/emacs-nougat-1

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Emacs Nougat

Collaborative Emacs configuration is currently limited to the following options:

  • Encapsulate features of configuration into packages and distribute them
  • Hand pick snippets out of other people’s config and never benefit from enhancements they make later.
  • Something even worse like a fucking wiki.

Emacs-nougat is a repository of “not-quite-packagable” snippets (nougat) and a system for composing them into a config file.

How does it work?

It’s crazy simple.

Create an outline

An outline, like those you’ll find in user-outlines/ is an org-mode document which can be structured however you like. Put elisp inside of #+begin_src emacs-lisp .. #+end_src blocks to have them part of your emacs config.

Include some nougat

Browse the nougat/ directory and find snippets that you find useful. Then anywhere within your outline you can include it:

#+INCLUDE: "../nougat/package-management/straight.org"

If you want to include a specific heading from a nougat file you can do that too:

#+INCLUDE: "../nougat/package-management/straight.org::use-package integration"

Build your config

With an outline located at user-outlines/my-config.org, then from the root of the repository run the build script:

./bin/build-elisp.sh my-outline
less ./user-outlines/my-config.el

You can copy this to ~/.emacs.d/init.el or create a symlink to it, or simply run (load-file path-to-el-file) from your existing config.

Contributing

Fork us, add your outline, and contribute your nougat!

About

Modular Emacs configuration amenable to collaboration!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Emacs Lisp 90.8%
  • Shell 5.3%
  • Makefile 3.9%