Using Org-mode for literate Emacs configuration with use-package

Using Org-mode for literate Emacs configuration with use-package

[Sébastien Gendre]

[-- Attachment #1: Type: text/plain, Size: 1172 bytes --]

Hello,

I am using Org-mode and the elisp function `(org-babel-load-file)` to
write my Emacs configuration into an Org-mode document. It's very
useful to document my configuration and I can quickly do exports to HTML
or PDF when a friend want to know more about my configuration.

But, I have a problem.

Sometimes, I need to split a package configuration into multiple
sections of my Org-mode document. For example Org-mode, because I set a
lot of settings. By spiting my config, I can correctly document each
option and organize it in a more comprehensible way.

But with the elisp function `(use-package)`, I need to join each package
configuration into the call of `(use-package)` function. Which prevent
me from splitting my config into Org-mode sections.

I was thinking of writing Org-mode source block with different parts of
my `(use-package)` call, so I can distribute it into different section of my
Org-mode document. But in this case, I can no-longer evaluate my
`(use-package)` call directly from my Org-mode document.


Do you have any suggestion ? How do you manage this problem ?


Best regards

-------
Gendre Sébastien

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 849 bytes --]

Re: Using Org-mode for literate Emacs configuration with use-package

[Dilip via General discussions about Org-mode.]

Hi,

I also enjoy using literate org config.

I cannot think of a way to split config in org src blocks and evaluate it
easily.
Each src block needs to evaluated, although most of the time while
editing itself I do evaluate or =eval-buffer=.

There is one way I can think of, that is to use =noweb= inside one
block. That might add little noise if you do many splits, but it works.
You can do =org-babel-expand-src-block= to get the output.

Or you may just use many use-package src block for that package.

With =:custom= keyword in use-package, you can add some doc for that
variable.

  Eg: (use-package org :custom
                       (org-ellipsis ".." "Some doc"))

I'm interested in knowing others opinion, and how they use it.

I use both emacs and nixos config in org-mode.
https://github.com/idlip/d-nix/blob/gol-d/d-setup.org

Other resource that uses a method that lets you use single noweb
reference to tangle all src block name.
Eg: You can use just <<org-conf>> and have any number of src block with
same #+name:org-conf name
https://github.com/rasendubi/dotfiles

Best,
Dilip