Org knit #4065

tecosaur · 2020-10-09T19:40:58Z

See https://discourse.doomemacs.org/t/org-knit-development/1432 for task list and discussion.

Usage: org-knit [OPTIONS] [TARGETS...]

A command line interface for weaving (exporting) and tangling org-mode files.
TARGETS can be files of folders (which are searched for org files recursively).

This is useful for automated generation of files,
and integration with other scripts.

Example:
  org-knit some-file.org
  org-knit -f pdf book/chapters/
  org-knit -t -f ascii,md scripts.org

Options:
  -a, --alias [FORMATS]	Give the org function called by a particlar alias.
  			List all aliases when no format or other arguments are given
  -c, --clean		Delete all non-org files which share their basename
  -e, --exec		Execute src blocks in the file before exporting
  -f, --format FORMATS	Export formats (comma seperated, no space), html by default
  -j, --jobs		Number of jobs executed in parallel (14 by default)
  -l, --load		Elisp files to load
  -s, --sync		Perform the exporting/tangling synchronously
  -t, --tangle		Also tangle the file(s).
  			See org-tangle for more advanced functionallity
  -q, --quiet		Suppress the output of status information
  -   			Output to stdout instead of writing to files

`org-knit -a`

`org-knit -s -f ascii,md,html *.org`

tecosaur · 2021-07-31T07:33:46Z

Update: after a long delay I'm coming back to this 🙂

github-actions · 2021-11-11T00:40:44Z

⚠️ This pull request has been automatically marked stale due to 60 days of inactivity. If this PR is still valid, please reply to it or it will be closed in 7 days.

tecosaur · 2021-11-17T21:43:09Z

A wonderful bird is the pelican,
His bill can hold more than his beli-can.
He can take in his beak
Food enough for the week;
But I'm damned if I see how the heli-can.

Now that we've reclaimed the master branch, the develop branch will soon be phased out.

BREAKING CHANGE: This commit changes the behaviour of the TAB and RET keys in a consult-completing read multiple session, in order to make them more intuitive. The behaviour is now: - TAB: (unchanged) always select or deselect the current candidate, and if the candidate is selected, move the index to the next one (this allows for pressing TAB repeatedly to select multiple subsequent candidates). - RET: If no candidates have been selected, select the current candidate and exit the completion session. If some have been selected, disregard the current candidate and exit. - S-TAB: (new) like TAB, but the keeps the input.

iyefrat/all-the-icons-completion@a0f34d68cc12 -> iyefrat/all-the-icons-completion@9e7d456b0934 minad/consult@cc8eff9578f5 -> minad/consult@0940ca016531 minad/marginalia@2fb2787bc302 -> minad/marginalia@9229d88ae475 minad/vertico@eedcb8478692 -> minad/vertico@a8fe9a0b2e15 oantolin/embark@e08899ef2e7f -> oantolin/embark@c9b26c2e18f0

The C-c C-s binding mirrors the export and writable export bindings. embark-export is used for type specific exports (such as buffers to an ibuffer buffer), not for verbatim exports. This is most noticeable if you want to export a variable list, which gets you to an apropos buffer. if you just want a list of things to keep around, embark-collect-snapshot is the tool for the job, but having it be only on C-; S makes it harder to reach and less visible. C-c C-s is a nice visible thing to have around.

This ensures that argument processing occurs before any further actions relying on the arguments.

Just calling `error' leads to a full stacktrace. Now we just give the error message and exit.

This is accomplished treating tangling as a special case publishing format.

This may be nicer with a if-required check in future, but for now this allows this to work at all on Emacs 27.

This just adds clutter, as we manage this ourselves.

When code-block evaluation changes the contents of the buffer, it should be saved.

When using `find-file-noselect', there are quite a few things are run implicitly, which can cause issues. Using `insert-file-contents' instead is much more predictable, and thus safe.

The tangle action (tang) was marked as "completed" regardless. It should be included in the `condition-case' and only run when there is no error.

github-actions · 2022-03-23T12:23:12Z

⚠️ This pull request has been automatically marked stale due to 60 days of inactivity. If this PR is still valid, please reply to it or it will be closed in 7 days.

tecosaur · 2022-03-30T12:50:13Z

Delayed but not abandoned.

hlissner · 2024-02-16T09:54:26Z

This was auto-closed because I deleted the develop branch, but I'm still interested in the functionality. I will revisit it after v3.

tecosaur · 2024-02-16T10:00:53Z

NP. Likewise, happy to revisit later. I think this is 80-90% there, and neat functionality to have.

from: PR doomemacs#4065

hlissner added module:lang/org Pertains to Doom's :lang org module is:feature Adds or requests new features, or extends existing ones module:core:binscripts Pertains to one of Doom's bin scripts and removed module:lang/org Pertains to Doom's :lang org module labels Dec 13, 2020

tecosaur force-pushed the org-knit branch from 047768d to e89ccdd Compare July 31, 2021 06:31

tecosaur force-pushed the org-knit branch 2 times, most recently from 7bbee61 to 33709de Compare July 31, 2021 15:50

tecosaur force-pushed the org-knit branch 3 times, most recently from 3790b5f to 6826cb6 Compare August 8, 2021 06:32

tecosaur force-pushed the org-knit branch 4 times, most recently from 6cf9893 to 736c769 Compare September 11, 2021 17:24

github-actions bot added the stale No response, forgotten, or abandoned label Nov 11, 2021

tecosaur force-pushed the org-knit branch from 736c769 to 22532fb Compare November 13, 2021 14:01

github-actions bot removed the stale No response, forgotten, or abandoned label Nov 18, 2021

tecosaur force-pushed the org-knit branch 2 times, most recently from faf84fb to 5118f60 Compare January 10, 2022 04:33

hlissner and others added 8 commits January 13, 2022 21:54

dev: remove develop branch stipulation in PR template

f73ae8e

Now that we've reclaimed the master branch, the develop branch will soon be phased out.

docs: target master branch in CI badges

8374438

dev: target master branch

5274f1a

nit(vertico): lint embark-file-map bindings

6d31e39

feat(vertico): add SPC s e to manual preview list

f42f923

tecosaur added 17 commits January 22, 2022 15:25

refactor(&org-knit): process input earlier

673bb27

This ensures that argument processing occurs before any further actions relying on the arguments.

fix(&org-knit): make table alignment more robust

d60b72d

feat(&org-knit): a sensational table toprule

f3e772c

feat(&org-knit): implement parallel job limiting

9ee5e20

nit(&org-knit): improve error/warning output

cb99be9

Just calling `error' leads to a full stacktrace. Now we just give the error message and exit.

nit(&org-knit): make it clearer which fmt viable

3ac39f6

fix(&org-knit): allow for just tangling files

0e7e670

This is accomplished treating tangling as a special case publishing format.

feat(&org-knit): use stderr for status information

981a168

feat(&org-knit): implement stdout tangle/export

9c571d1

feat(&org-knit): implement quiet flag (-q)

846b06d

fix(&org-knit): backport string-pad from Emacs 28

b78c1d5

This may be nicer with a if-required check in future, but for now this allows this to work at all on Emacs 27.

nit(&org-knit): no need for Emacs' backup files

e5f429a

This just adds clutter, as we manage this ourselves.

feat(&org-knit): save file when eval changes hash

a014e99

When code-block evaluation changes the contents of the buffer, it should be saved.

fix(&org-knit): insert file content over find-file

3c4e8ce

When using `find-file-noselect', there are quite a few things are run implicitly, which can cause issues. Using `insert-file-contents' instead is much more predictable, and thus safe.

fix(&org-knit): failed tangles are not completed

b628e6b

The tangle action (tang) was marked as "completed" regardless. It should be included in the `condition-case' and only run when there is no error.

tweak(&org-knit): don't use async with lone export

9810d97

temp stuff

50424de

tecosaur force-pushed the org-knit branch from 5118f60 to 50424de Compare January 22, 2022 07:26

github-actions bot added the stale No response, forgotten, or abandoned label Mar 23, 2022

github-actions bot closed this Mar 30, 2022

tecosaur reopened this May 2, 2022

hlissner removed the stale No response, forgotten, or abandoned label Mar 22, 2023

hlissner deleted the branch doomemacs:develop February 16, 2024 09:51

hlissner closed this Feb 16, 2024

levindu added a commit to levindu/doomemacs that referenced this pull request Sep 3, 2024

add org-knit

1f38e6a

from: PR doomemacs#4065

levindu added a commit to levindu/doomemacs that referenced this pull request Jul 29, 2025

add org-knit

fa8afc2

from: PR doomemacs#4065

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Org knit #4065

Org knit #4065

Uh oh!

tecosaur commented Oct 9, 2020 •

edited

Loading

Uh oh!

tecosaur commented Jul 31, 2021

Uh oh!

github-actions bot commented Nov 11, 2021

Uh oh!

tecosaur commented Nov 17, 2021

Uh oh!

github-actions bot commented Mar 23, 2022

Uh oh!

tecosaur commented Mar 30, 2022

Uh oh!

hlissner commented Feb 16, 2024

Uh oh!

tecosaur commented Feb 16, 2024

Uh oh!

Uh oh!

Uh oh!

Org knit #4065

Org knit #4065

Uh oh!

Conversation

tecosaur commented Oct 9, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

org-knit -a

org-knit -s -f ascii,md,html *.org

Uh oh!

tecosaur commented Jul 31, 2021

Uh oh!

github-actions bot commented Nov 11, 2021

Uh oh!

tecosaur commented Nov 17, 2021

Uh oh!

github-actions bot commented Mar 23, 2022

Uh oh!

tecosaur commented Mar 30, 2022

Uh oh!

hlissner commented Feb 16, 2024

Uh oh!

tecosaur commented Feb 16, 2024

Uh oh!

Uh oh!

tecosaur commented Oct 9, 2020 •

edited

Loading

`org-knit -a`

`org-knit -s -f ascii,md,html *.org`