Based on the awesome Emacs from scratch series by David Wilson.
- Welcome!
- Tips for Use
- Startup Benchmarking
- Package System Setup
- Basic UI Configuration
- Keybinding Configuration
- UI Configuration
- Org Mode
- Links y contenido web
- Development
- Terminal
- Navigation
- Productivity
- Presentations
This is the configuration we’ve been building in the Emacs From Scratch series, now written as an Org Mode document. This file generates init.el which can be loaded by Emacs at startup.
NOTE: If you run into any issues while using this configuration, please file an issue or send me an email at david at systemcrafters.cc.
The following variables are used to tweak some of the configuration pieces for use in the live streams so you might need to adjust them for your local machine if you try to use this configuration directly.
;; NOTE: init.el is now generated from Emacs.org. Please edit that file
;; in Emacs and init.el will be generated automatically!
;; You will most likely need to adjust this font size for your system!
(defvar ag/default-font-size 130)
(defvar ag/default-variable-font-size 1.02)
;; Make frame transparency overridable
(defvar ag/frame-transparency '(96 . 96))
In this document I’ve added links in many places that lead you to documentation for the various packages we use. If you’re looking at this file in Emacs, you can put your cursor on a link and press C-c C-o or run M-x org-open-at-point to open the link in your web browser.
Add a function to emacs-startup-hook to print out the duration of Emacs startup:
(setq gc-cons-threshold (* 2 1000 1000))
(defun ag/display-startup-time ()
(message "Emacs loaded in %s with %d garbage collections."
(format "%.2f seconds"
(float-time
(time-subtract after-init-time before-init-time)))
gcs-done))
(add-hook 'emacs-startup-hook #'ag/display-startup-time)
All startup behavior is happening in the normal-top-level function!
A helpful manual page is Summary: Sequence of Actions at Startup.
use-package gives you a few different ways to defer package loading:
:hook- Package will be loaded the first time one of the hooks is invoked:bind- Package will be loaded the first time one of the key bindings is used:commands- Package will be loaded when one of the commands are used:mode- Package will be loaded the first time a file with a particular extension is opened:after- Load this package after other specific packages are loaded:defer- If you don’t use any of the other options, this one will defer loading until after startup
There are a few other options use-package provides, but these are all the most likely ones you would use.
The strategy is to look at all of your use-package expressions and decide whether it really needs to be loaded immediately at startup!
If you want to make sure a package gets loaded at startup despite the use of any of the options above, use :demand t.
Let’s try it!
Emacs has a built in package manager but it doesn’t make it easy to automatically install packages on a new system the first time you pull down your configuration. use-package is a really helpful package used in this configuration to make it a lot easier to automate the installation and configuration of everything else we use.
;; Initialize package sources
(require 'package)
(setq package-archives '(("melpa" . "https://melpa.org/packages/")
("org" . "https://orgmode.org/elpa/")
("elpa" . "https://elpa.gnu.org/packages/")))
(package-initialize)
(unless package-archive-contents
(package-refresh-contents))
;; Initialize use-package on non-Linux platforms
(unless (package-installed-p 'use-package)
(package-install 'use-package))
(require 'use-package)
(setq use-package-always-ensure t)
(setq use-package-verbose t)
(use-package no-littering)
(setq no-littering-etc-directory
(expand-file-name "config/" user-emacs-directory))
(setq no-littering-var-directory
(expand-file-name "data/" user-emacs-directory))
(require 'no-littering)
(setq auto-save-file-name-transforms
`((".*" ,(no-littering-expand-var-file-name "auto-save/") t)))
(setq backup-directory-alist `(("." . "~/.emacs.d/data/backup")))The auto-package-update package helps us keep our Emacs packages up to date! It will prompt you after a certain number of days either at startup or at a specific time of day to remind you to update your packages.
You can also use M-x auto-package-update-now to update right now!
(use-package auto-package-update
:custom
(auto-package-update-interval 15)
(auto-package-update-prompt-before-update t)
(auto-package-update-hide-results t)
:config
(auto-package-update-maybe)
(auto-package-update-at-time "09:00"))
(defun ag/immortal-buffers ()
(if (or (eq (current-buffer) (get-buffer "*scratch*"))
(eq (current-buffer) (get-buffer "*Messages*")))
(progn (bury-buffer)
nil)
t))
(add-hook 'kill-buffer-query-functions 'ag/immortal-buffers)
(setq save-interprogram-paste-before-kill t)
(setq delete-selection-mode 1)
This section configures basic UI settings that remove unneeded elements to make Emacs look a lot more minimal and modern. If you’re just getting started in Emacs, the menu bar might be helpful so you can remove the (menu-bar-mode -1) line if you’d like to still see that.
(setq inhibit-startup-message t)
(scroll-bar-mode -1) ; Disable visible scrollbar
(tool-bar-mode -1) ; Disable the toolbar
(tooltip-mode -1) ; Disable tooltips
(set-fringe-mode 10) ; Give some breathing room
(menu-bar-mode -1) ; Disable the menu bar
;; Set up the visible bell
(setq visible-bell nil)
(setq ring-bell-function (lambda ()
(invert-face 'mode-line)
(run-with-timer 0.1 nil 'invert-face 'mode-line)))
(column-number-mode)
(global-display-line-numbers-mode t)
;; Set frame transparency
(set-frame-parameter (selected-frame) 'alpha ag/frame-transparency)
(add-to-list 'default-frame-alist `(alpha . ,ag/frame-transparency))
(setq mac-command-modifier 'super)
(setq mac-option-modifier 'meta)
;; (set-frame-parameter (selected-frame) 'fullscreen 'maximized)
;; (add-to-list 'default-frame-alist '(fullscreen . maximized))
;; Disable line numbers for some modes
(dolist (mode '(org-mode-hook
term-mode-hook
vterm-mode-hook
deft-mode-hook
shell-mode-hook
reftex-select-bib-mode-hook
pdf-outline-buffer-mode-hook
org-agenda-mode-hook
pdf-view-mode-hook))
(add-hook mode (lambda () (display-line-numbers-mode 0)))
)
(use-package all-the-icons)
(use-package nerd-icons)
(use-package page-break-lines)
(use-package projectile)(use-package dashboard
:ensure t
:config
(setq dashboard-display-icons-p t) ;; display icons on both GUI and terminal
;; (setq dashboard-icon-type 'all-the-icons) ;; use `all-the-icons' package
(setq dashboard-icon-type 'nerd-icons) ;; use `nerd-icons' package
(setq dashboard-startup-banner 'logo)
(setq dashboard-center-content t)
(setq dashboard-set-heading-icons t)
(setq dashboard-set-file-icons t)
(setq dashboard-set-navigator t)
(setq dashboard-week-agenda t)
(setq dashboard-filter-agenda-entry 'dashboard-no-filter-agenda)
(setq dashboard-match-agenda-entry "+projects+CATEGORY=\"tasks\"/!")
(setq dashboard-agenda-prefix-format "%-2i ")
(setq dashboard-agenda-tags-format 'ignore)
(dashboard-modify-heading-icons '((projects . "nf-oct-rocket")
(agenda . "nf-oct-milestone")
(recents . "nf-oct-history")
(bookmarks . "nf-oct-bookmark")))
(setq dashboard-projects-switch-function 'counsel-projectile-switch-project-by-name)
(setq dashboard-items '(
(recents . 10)
(projects . 5)
;; (bookmarks .s 5)
(agenda . 10)
))
(setq dashboard-navigator-buttons
`((;; Github
(,(nerd-icons-octicon "nf-oct-mark_github" :height 1.1 :v-adjust 0.0)
"Github"
"Go to Github"
(lambda (&rest _) (browse-url "https://github.com/agarbuno/")))
;; Perspectives
(,(nerd-icons-octicon "nf-oct-history" :height 1.1 :v-adjust 0.0)
"Restore"
"Restore window configuration"
(lambda (&rest _) (persp-state-load persp-state-default-file)))
)))
(dashboard-setup-startup-hook)
)I am using the Fira Code and Cantarell fonts for this configuration which will more than likely need to be installed on your machine. Both can usually be found in the various Linux distro package managers or downloaded from the links above.
(set-face-attribute
'default nil
:font "JetBrains Mono"
:height ag/default-font-size
)
;; Set the fixed pitch face
(set-face-attribute
'fixed-pitch nil
:font "JetBrains Mono"
:weight 'medium
:height ag/default-variable-font-size
)
;; Set the variable pitch face
(set-face-attribute
'variable-pitch nil
:font "Cantarell"
:height ag/default-variable-font-size
:weight 'regular
)
(use-package solaire-mode
:config
(solaire-global-mode 1)
)This configuration uses evil-mode for a Vi-like modal editing experience. general.el is used for easy keybinding configuration that integrates well with which-key. evil-collection is used to automatically configure various Emacs modes with Vi-like keybindings for evil-mode.
For more keybinding configurations take a look in: key bindings - Enable OS X keys in Emacs - Emacs Stack Exchange
;; Make ESC quit prompts
(global-set-key (kbd "<escape>") 'keyboard-escape-quit)
;; Adds accents in spanish
(global-set-key (kbd "M-a") '(lambda () (interactive) (insert "á")))
(global-set-key (kbd "M-e") '(lambda () (interactive) (insert "é")))
(global-set-key (kbd "M-i") '(lambda () (interactive) (insert "í")))
(global-set-key (kbd "M-o") '(lambda () (interactive) (insert "ó")))
(global-set-key (kbd "M-u") '(lambda () (interactive) (insert "ú")))
(global-set-key (kbd "M-y") '(lambda () (interactive) (insert "ü")))
(global-set-key (kbd "M-n") '(lambda () (interactive) (insert "ñ")))
(global-set-key (kbd "s-/") '(lambda () (interactive) (insert "¿")))
;; For macOS type of keybindings
(global-set-key (kbd "<s-up>") 'beginning-of-buffer)
(global-set-key (kbd "<s-down>") 'end-of-buffer)
(global-set-key (kbd "<s-left>") 'beginning-of-line)
(global-set-key (kbd "<s-right>") 'end-of-line)
;;
(global-set-key (kbd "s-u") 'revert-buffer)
(global-set-key (kbd "s-z") 'undo)
(global-set-key (kbd "s-x") 'kill-region)
(global-set-key (kbd "s-v") 'yank)
(global-set-key (kbd "s-c") 'kill-ring-save)
(global-set-key (kbd "s-a") 'mark-whole-buffer)
(global-set-key (kbd "s-l") 'goto-line)
(global-set-key (kbd "s-s") 'save-buffer)
(use-package general
:after evil
:config
(general-create-definer ag/leader-keys
:keymaps '(normal insert visual emacs)
:prefix "SPC"
:global-prefix "C-c h")
(ag/leader-keys
"t" '(:ignore t :which-key "toggles")
"tt" '(counsel-load-theme :which-key "choose theme")
;; Load emacs config
"fe" '(lambda () (interactive) (find-file (expand-file-name "~/.dotfiles/emacs.org")))
"fs" '(lambda () (interactive) (find-file (expand-file-name "~/.emacs.d/init.el")))
;; Visual toggle
"v" '(:ignore t :which-key "visual")
"vl" '(org-toggle-link-display :which-key "toggle links")
"vs" '(org-display-inline-images :which-key "toggle images")
))
(use-package evil
:init
(setq evil-want-integration t)
(setq evil-want-keybinding nil)
(setq evil-want-C-u-scroll t)
(setq evil-want-C-i-jump nil)
:config
(evil-mode 1)
(define-key evil-insert-state-map (kbd "C-g") 'evil-normal-state)
(define-key evil-insert-state-map (kbd "C-h") 'evil-delete-backward-char-and-join)
;; Use visual line motions even outside of visual-line-mode buffers
(evil-global-set-key 'motion "j" 'evil-next-visual-line)
(evil-global-set-key 'motion "k" 'evil-previous-visual-line)
(evil-set-initial-state 'messages-buffer-mode 'normal)
(evil-set-initial-state 'dashboard-mode 'normal)
(evil-set-initial-state 'text-mode 'emacs)
)
(use-package evil-collection
:after evil
:config
(evil-collection-init))
command-log-mode is useful for displaying a panel showing each key binding you use in a panel on the right side of the frame. Great for live streams and screencasts!
(use-package command-log-mode
:commands command-log-mode)
doom-themes is a great set of themes with a lot of variety and support for many different Emacs modes. Taking a look at the screenshots might help you decide which one you like best. You can also run M-x counsel-load-theme to choose between them easily.
(defun ag/org-color-setup()
(set-face-attribute 'org-block nil
:background (color-darken-name
(face-attribute 'default :background) 5)
:font "JetBrains Mono"
:height ag/default-variable-font-size
)
(set-face-attribute 'org-block-begin-line nil
:background (color-darken-name
(face-attribute 'default :background) -10))
(set-face-attribute 'org-drawer nil
:font "JetBrains Mono"
)
)
(use-package doom-themes
;; :init (load-theme 'doom-monokai-pro t))
;; :init (load-theme 'doom-snazzy t))
;; :init (load-theme 'doom-moonlight t))
;; :init (load-theme 'doom-nord-aurora t))
:init (load-theme 'doom-ayu-light t))
;; :init (load-theme 'doom-nord-light t))
;; :config (load-theme 'doom-nord t))
(use-package color
:after org
:config
(set-face-attribute 'org-block nil
:background
(color-darken-name
(face-attribute 'default :background) 5)
:font "JetBrains Mono"
:height ag/default-variable-font-size)
(set-face-attribute 'org-block-begin-line nil
:background
(color-darken-name
(face-attribute 'default :background) -10))
(set-face-attribute 'org-drawer nil
:font "JetBrains Mono"
)
)
doom-modeline is a very attractive and rich (yet still minimal) mode line configuration for Emacs. The default configuration is quite good but you can check out the configuration options for more things you can enable or disable.
NOTE: The first time you load your configuration on a new machine, you’ll need to run `M-x all-the-icons-install-fonts` so that mode line icons display correctly.
(use-package doom-modeline
:init (doom-modeline-mode 1)
:config
(setq doom-modeline-height 25)
;; (setq display-battery-mode t)
(setq display-time-mode nil)
(setq display-time-24hr-format 1)
(setq display-time-day-and-date 1)
(setq find-file-visit-truename t)
(setq doom-modeline-project-detection 'project)
(setq doom-modeline-project-detection 'ffip)
)
(use-package minions
:config
(setq doom-modeline-minor-modes t)
(minions-mode 1)
)
which-key is a useful UI panel that appears when you start pressing any key binding in Emacs to offer you all possible completions for the prefix. For example, if you press C-c (hold control and press the letter c), a panel will appear at the bottom of the frame displaying all of the bindings under that prefix and which command they run. This is very useful for learning the possible key bindings in the mode of your current buffer.
(use-package which-key
:defer 0
:diminish which-key-mode
:config
(which-key-mode)
(setq which-key-idle-delay 1))
Ivy is an excellent completion framework for Emacs. It provides a minimal yet powerful selection menu that appears when you open files, switch buffers, and for many other tasks in Emacs. Counsel is a customized set of commands to replace `find-file` with `counsel-find-file`, etc which provide useful commands for each of the default completion commands.
ivy-rich adds extra columns to a few of the Counsel commands to provide more information about each item.
Maybe I need to change to ivy-rich with nerd-icons-ivy-rich.
(use-package ivy
:diminish
:bind (("C-s" . swiper)
:map ivy-minibuffer-map
("TAB" . ivy-alt-done)
("C-l" . ivy-alt-done)
("C-j" . ivy-next-line)
("C-k" . ivy-previous-line)
:map ivy-switch-buffer-map
("C-k" . ivy-previous-line)
("C-l" . ivy-done)
("C-d" . ivy-switch-buffer-kill)
:map ivy-reverse-i-search-map
("C-k" . ivy-previous-line)
("C-d" . ivy-reverse-i-search-kill))
:config
;; (message "Ivy got loaded!")
(ivy-mode 1)
(setq ivy-use-selectable-prompt t)
;; (setq ivy-wrap t)
)
(use-package counsel
:bind (("C-M-j" . 'counsel-switch-buffer)
:map minibuffer-local-map
("C-r" . 'counsel-minibuffer-history))
:config
(counsel-mode 1))
(use-package nerd-icons-ivy-rich
:after ivy
:init
(nerd-icons-ivy-rich-mode 1)
)
(use-package ivy-rich
:after nerd-icons-ivy-rich
:init
(ivy-rich-mode 1))
Helpful adds a lot of very helpful (get it?) information to Emacs’ describe- command buffers. For example, if you use describe-function, you will not only get the documentation about the function, you will also see the source code of the function and where it gets used in other places in the Emacs configuration. It is very useful for figuring out how things work in Emacs.
(use-package helpful
:commands (helpful-callable helpful-variable helpful-command helpful-key)
:custom
(counsel-describe-function-function #'helpful-callable)
(counsel-describe-variable-function #'helpful-variable)
:bind
([remap describe-function] . counsel-describe-function)
([remap describe-command] . helpful-command)
([remap describe-variable] . counsel-describe-variable)
([remap describe-key] . helpful-key))
This is an example of using Hydra to design a transient key binding for quickly adjusting the scale of the text on screen. We define a hydra that is bound to C-s t s and, once activated, j and k increase and decrease the text scale. You can press any other key (or f specifically) to exit the transient key map.
(use-package hydra
:defer t)
(defhydra hydra-text-scale (:timeout 4)
"scale text"
("j" text-scale-increase "in")
("k" text-scale-decrease "out")
("f" nil "finished" :exit t))
(ag/leader-keys
"ts" '(hydra-text-scale/body :which-key "scale text"))
(use-package ivy-prescient
:after counsel
:config
(ivy-prescient-mode 1)
(prescient-persist-mode 1))
(setq prescient-sort-length-enable nil)
(setq ivy-prescient-retain-classic-highlighting t)
(use-package beacon
:ensure t
:config
(beacon-mode 1)
(setq beacon-blink-when-focused 1)
(setq beacon-size 70)
)Let’s make indentation with 4 spaces and no tab
(use-package emacs
:config
(setq-default indent-tabs-mode nil)
(setq tab-width 4)
(setq-default tab-always-indent 'complete)
)You can use persepective to keep the buffers somewhat organized. Since I am using ivy as a completion framework I will keep using the appropriate configuration for it. Let’s use persp-ivy-switch-buffer or persp-counsel-switch-buffer for better integration.
(use-package perspective
:ensure t
:custom
(persp-mode-prefix-key (kbd "C-x x"))
:bind
(("C-x k" . persp-kill-buffer*)
("C-x b" . persp-ivy-switch-buffer))
:init
(persp-mode)
(setq persp-save-dir "~/.emacs.d/perspective/")
(setq persp-state-default-file "~/.emacs.d/perspective/workflow.persp")
(setq persp-sort 'created)
)
Visit Declutter Your Emacs Buffers with Perspective.el to learn more about useful keybindings under perspective mode.
| binding | action |
|---|---|
C-x x s | switch perspective (create if need) |
C-x x b | lists all buffers, switches to perspective |
C-x x n | cycle through available perspectives |
C-x x p | idem |
C-x x a | add buffer to perspective |
C-x x k | perspective kill command for buffers |
C-x x c | kills perspective |
(fset 'yes-or-no-p 'y-or-n-p)Org Mode is one of the hallmark features of Emacs. It is a rich document editor, project planner, task and time tracker, blogging engine, and literate coding utility all wrapped up in one package.
The ag/org-font-setup function configures various text faces to tweak the sizes of headings and use variable width fonts in most cases so that it looks more like we’re editing a document in org-mode. We switch back to fixed width (monospace) fonts for code blocks and tables so that they display correctly.
(defun ag/org-font-setup ()
;; Replace list hyphen with dot
(font-lock-add-keywords 'org-mode
'(("^ *\\([-]\\) "
(0 (prog1 () (compose-region (match-beginning 1) (match-end 1) "•"))))))
;; Set faces for heading levels
(dolist (face '((org-level-1 . 1.2)
(org-level-2 . 1.1)
(org-level-3 . 1.05)
(org-level-4 . 1.0)
(org-level-5 . 1.1)
(org-level-6 . 1.1)
(org-level-7 . 1.1)
(org-level-8 . 1.1)))
(set-face-attribute (car face) nil :font "Cantarell" :weight 'regular :height (cdr face)))
;; Ensure that anything that should be fixed-pitch in Org files appears that way
(set-face-attribute 'org-block nil :foreground nil :inherit 'fixed-pitch)
(set-face-attribute 'org-code nil :inherit '(shadow fixed-pitch))
(set-face-attribute 'org-table nil :inherit '(shadow fixed-pitch))
(set-face-attribute 'org-verbatim nil :inherit '(shadow fixed-pitch))
(set-face-attribute 'org-special-keyword nil :inherit '(font-lock-comment-face fixed-pitch))
(set-face-attribute 'org-meta-line nil :inherit '(font-lock-comment-face fixed-pitch))
(set-face-attribute 'org-checkbox nil :inherit 'fixed-pitch)
(set-face-underline 'org-link nil)
(set-face-foreground 'org-link "#B92A45")
)
This section contains the basic configuration for org-mode plus the configuration for Org agendas and capture templates. There’s a lot to unpack in here so I’d recommend watching the videos for Part 5 and Part 6 for a full explanation.
(use-package org-fancy-priorities ; priority icons
:hook (org-mode . org-fancy-priorities-mode)
:config (setq org-fancy-priorities-list '("★★★" "★★☆" "★☆☆")))
(defun ag/org-mode-setup ()
(org-indent-mode)
(variable-pitch-mode 1)
(visual-line-mode 1)
(ag/org-font-setup)
(ag/org-color-setup)
(setq fill-column 80)
(setq org-image-actual-width (list 750)))(use-package org
:commands (org-capture org-agenda)
:hook ((org-mode . ag/org-mode-setup)
(org-mode . ag/org-reveal))
:config
(setq org-ellipsis " ▾")
(setq org-support-shift-select t)
(setq org-latex-classes nil)
(setq org-agenda-start-with-log-mode t)
(setq org-popup-calendar-for-date-prompt t)
(setq org-log-done 'time)
(setq org-log-into-drawer t)
(setq org-agenda-files
'("~/orgfiles/agenda/tasks.org"
"~/orgfiles/agenda/habits.org"))
(setq org-todo-keywords
'((sequence "TODO(t)" "NEXT(n)" "|" "DONE(d)")
(sequence "WAIT(w)" "|" "BACKLOG(b)" "CANCEL(c)"))
)
(setq org-refile-targets
'(("archive.org" :maxlevel . 1)
("tasks.org" :maxlevel . 1)))
(setq org-todo-keyword-faces
'(("TODO" . (:foreground "hot pink" :weight bold))
("DONE" . (:foreground "#00e6ab" :weight bold))
("NEXT" . (:foreground "dark orange" :weight bold))
("WAIT" . (:foreground "#aeffff" :weight bold))
("CANCEL" . (:foreground "dark red" :weight bold :strike-through t))
("BACKLOG" . (:foreground "dark gray" :weight bold :underline t))
))
(setq org-tag-alist
'((:startgroup)
;; Put mutually exclusive tags here
(:endgroup)
("discipline" . ?d)
("course" . ?c)
("email" . ?e)
("followup" . ?f)
("project". ?p)
("read" . ?r)
("wait" . ?w)
));; Save Org buffers after refiling!
(advice-add 'org-refile :after 'org-save-all-org-buffers)(setq org-agenda-custom-commands
'(("d" "Dashboard"
((agenda "/!-BACKLOG" (
(org-agenda-start-on-weekday 0)
(org-agenda-remove-tags t)
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")
(org-deadline-warning-days 7)
))
(todo "NEXT|WAIT"
((org-agenda-overriding-header "Ongoing Tasks")
(org-agenda-sorting-strategy '(todo-state-up priority-down timestamp-up))
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")))
(tags-todo "+projects-CATEGORY=\"tasks\"/!-NEXT-WAIT"
((org-agenda-overriding-header "Ongoing Projects")
(org-agenda-sorting-strategy '(todo-state-up category-up priority-down))
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")))
(tags-todo "+projects+CATEGORY=\"tasks\"/!-NEXT-WAIT"
((org-agenda-overriding-header "Specific Project tasks")
(org-agenda-sorting-strategy '(todo-state-up category-up priority-down))
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")))
(tags-todo "+personal/!-NEXT"
((org-agenda-overriding-header "Personal todos")
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")))
(tags-todo "+research/!-NEXT"
((org-agenda-overriding-header "Research")
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")))
(todo "BACKLOG|BACK"
((org-agenda-overriding-header "Backlog")
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")))
(tags-todo "-research-teaching-mcdatos-projects-maestria-habits/!-NEXT"
((org-agenda-overriding-header "Unprocessed Inbox Tasks")
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")
;; (org-agenda-files "~/orgfiles/agenda/tasks.org")
(org-agenda-text-search-extra-files nil)
))
))
("n" "Next Tasks"
((todo "NEXT|WAIT"
((org-agenda-sorting-strategy '(todo-state-down category-up priority-down))
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")
(org-agenda-overriding-header "Next Tasks"))
)))
("w" "Work Tasks"
((tags-todo "+projects+CATEGORY=\"tasks\""
((org-agenda-sorting-strategy '(todo-state-down category-up priority-down))
(org-agenda-show-inherited-tags nil)
(org-agenda-prefix-format " %-2i ")
(org-agenda-overriding-header "Task List"))
)))
))(setq org-capture-templates
`(
("w" "projects" entry ;; ==============================================
(file+olp "~/orgfiles/agenda/tasks.org" "Projects")
"* TODO\t %?
:PROPERTIES:
:CAPTURED: %U
:CATEGORY: %^{Category|projects|tasks}
:END:\n %a\n %i" :empty-lines 1)
("m" "personal" entry ;; ==============================================
(file+olp "~/orgfiles/agenda/tasks.org" "Personal")
"* TODO\t %?
:PROPERTIES:
:CAPTURED: %U
:CATEGORY: %^{Category|tasks|reminders}
:END:\n %a\n %i" :empty-lines 1)
("r" "research" entry ;; ==============================================
(file+olp "~/orgfiles/agenda/tasks.org" "Research")
"* TODO\t %?
:PROPERTIES:
:CAPTURED: %U
:CATEGORY: %^{Task|ideas|read|write|book|paper}
:END:\n %a\n %i" :empty-lines 1)
))(define-key global-map (kbd "C-c t t")
(lambda () (interactive) (org-capture nil "tt")))
(global-set-key (kbd "C-c a") 'org-agenda)
(global-set-key (kbd "C-c t c") 'org-capture)
(require 'org-habit)
(setq org-habit-show-all-today t)
(setq org-habit-today-glyph ?◌)
(setq org-habit-graph-column 40)
(setq org-habit-following-days 1)
(setq org-habit-show-habits t)
(setq org-habit-completed-glyph ?●)
(setq org-habit-preceding-days 10)
(setq org-habit-show-habits-only-for-today t)
) ;; Termina configuracion
(setq org-agenda-category-icon-alist
`(;; Main categories =================================================
("research" ,(list (nerd-icons-octicon "nf-oct-rocket")) nil nil :ascent center)
("projects" ,(list (nerd-icons-octicon "nf-oct-rocket")) nil nil :ascent center)
("tasks" ,(list (nerd-icons-sucicon "nf-seti-todo")) nil nil :ascent center)
("habits" ,(list (nerd-icons-sucicon "nf-seti-todo")) nil nil :ascent center)
;; Subcategories ===================================================
("book" ,(list (nerd-icons-mdicon "nf-md-bookshelf")) nil nil :ascent center)
("email" ,(list (nerd-icons-mdicon "nf-md-email_outline")) nil nil :ascent center)
("followup" ,(list (nerd-icons-flicon "nf-linux-void")) nil nil :ascent center)
("read" ,(list (nerd-icons-mdicon "nf-md-book_open_page_variant_outline")) nil nil :ascent center)
)
)org-bullets replaces the heading stars in org-mode buffers with nicer looking characters that you can control. Another option for this is org-superstar-mode which we may cover in a later video.
(use-package org-bullets
:after org
:hook (org-mode . org-bullets-mode)
:custom
(org-bullets-bullet-list '("◉" "○" "●" "○" "●" "○" "●")))
We use visual-fill-column to center org-mode buffers for a more pleasing writing experience as it centers the contents of the buffer horizontally to seem more like you are editing a document. This is really a matter of personal preference so you can remove the block below if you don’t like the behavior.
(defun ag/org-mode-visual-fill ()
(setq visual-fill-column-width 110
visual-fill-column-center-text t)
(visual-fill-column-mode 1))
(use-package visual-fill-column
:hook (org-mode . ag/org-mode-visual-fill))
See interesting configurations here.
To execute or export code in org-mode code blocks, you’ll need to set up org-babel-load-languages for each language you’d like to use. This page documents all of the languages that you can use with org-babel.
(org-babel-do-load-languages
'org-babel-load-languages
'((emacs-lisp . t)
(latex . t)
(R . t)
(python . t)
(sql . t)
(shell . t)
(octave . t)
))
(with-eval-after-load 'org
;; This is needed as of Org 9.2
(require 'org-tempo)
(add-to-list 'org-structure-template-alist '("sh" . "src shell"))
(add-to-list 'org-structure-template-alist '("el" . "src emacs-lisp"))
(add-to-list 'org-structure-template-alist '("la" . "src latex"))
(add-to-list 'org-structure-template-alist '("r" . "src R"))
(add-to-list 'org-structure-template-alist '("co" . "src conf"))
(add-to-list 'org-structure-template-alist '("p" . "src python"))
(add-to-list 'org-structure-template-alist '("oct" . "src octave"))
)
(push '("conf-unix" . conf-unix) org-src-lang-modes)
(setq org-confirm-babel-evaluate nil)
(setq org-src-window-setup 'split-window-below)
(add-to-list 'org-file-apps '("\\.pdf\\'" . emacs))
(setq org-src-tab-acts-natively t)
This snippet adds a hook to org-mode buffers so that ag/org-babel-tangle-config gets executed each time such a buffer gets saved. This function checks to see if the file being saved is the Emacs.org file you’re looking at right now, and if so, automatically exports the configuration here to the associated output files.
;; Automatically tangle our Emacs.org config file when we save it
(defun ag/org-babel-tangle-config ()
(when (string-equal (buffer-file-name)
(expand-file-name "~/.dotfiles/emacs.org"))
;; Dynamic scoping to the rescue
(let ((org-confirm-babel-evaluate nil))
(org-babel-tangle))))
(add-hook 'org-mode-hook (lambda () (add-hook 'after-save-hook #'ag/org-babel-tangle-config)))
This package makes it much easier to edit Org documents when org-hide-emphasis-markers is turned on. It temporarily shows the emphasis markers around certain markup elements when you place your cursor inside of them. No more fumbling around with === and * characters!
(setq org-hide-emphasis-markers t)
(use-package org-appear
:hook (org-mode . org-appear-mode))
For more option for customization see: Simple question re org-roam - how to access capture templates? : orgmode.
This should be updated accordingly with respect to org-roam-v2.
(use-package org-roam
:init
(setq org-roam-v2-ack t)
:custom
(org-roam-directory (file-truename "~/orgfiles/"))
(org-roam-completion-everywhere t)
;; (org-roam-completion-system 'default)
;; Capture templates
(org-roam-capture-templates
'(("d" "default" plain "%?"
:if-new (file+head "pages/%<%Y%m%d%H%M%S>-${slug}.org"
"#+title: ${title}\n")
:unnarrowed t)
)
)
;; Dailies templates
(org-roam-dailies-directory "journals/")
(org-roam-dailies-capture-templates
'(("d" "default" entry
"\n\n* %?"
:if-new (file+head
"%<%Y-%m-%d>.org"
"#+title: %<%Y-%m-%d %a>\n#+filetags: :journal:\n"))
("t" "talks" entry
"\n\n* %^{Talk Title} by %^{Speaker} \t:talks: \n\n%?\n\n"
:if-new (file+head
"%<%Y-%m-%d>.org"
"#+title: %<%Y-%m-%d %a>\n#+filetags: :journal:\n"
))
("m" "meetings" entry
(file "~/.emacs.d/templates/org-capture/meetings-template")
:if-new (file+head
"%<%Y-%m-%d>.org"
"#+title: %<%Y-%m-%d %a>\n#+filetags: :journal:\n"
))
("i" "interviews" entry
(file "~/.emacs.d/templates/org-capture/interviews-template")
:if-new (file+head
"%<%Y-%m-%d>.org"
"#+title: %<%Y-%m-%d %a>\n#+filetags: :journal:\n"
))
))
:bind (("C-c n b" . org-roam-buffer-toggle)
("C-c n f" . org-roam-node-find)
("C-c n g" . org-roam-graph)
("C-c n i" . org-roam-node-insert)
("C-c n ]" . org-roam-node-insert-immediate)
("C-c n c" . org-roam-capture)
("C-c n t" . org-roam-tag-add)
("C-c n r" . org-roam-tag-remove)
("C-c n k" . org-id-get-create)
;; Dailies
("C-c n m" . org-roam-dailies-capture-today)
:map org-mode-map
("C-M-i" . completion-at-point)
)
:config
(org-roam-db-autosync-mode)
(add-to-list 'display-buffer-alist
'("\\*org-roam\\*"
(display-buffer-in-direction)
(direction . right)
(window-width . 0.33)
(window-height . fit-window-to-buffer)))
(defun org-roam-node-insert-immediate (arg &rest args)
(interactive "P")
(let ((args (cons arg args))
(org-roam-capture-templates (list (append (car org-roam-capture-templates)
'(:immediate-finish t)))))
(apply #'org-roam-node-insert args)))(cl-defmethod org-roam-node-filetitle ((node org-roam-node))
"Return the file TITLE for the node."
(org-collect-kewords "TITLE" (org-roam-node-file node))
)
(cl-defmethod org-roam-node-backlinkscount ((node org-roam-node))
(let* ((count (caar (org-roam-db-query
[:select (funcall count source)
:from links
:where (= dest $s1)
:and (= type "id")]
(org-roam-node-id node)))))
(if (> count 0)
(concat (propertize "=@=" 'display (all-the-icons-material "link" :face 'all-the-icons-dblue :height 0.9)) (format "%3d" count))
(concat (propertize "=@=" 'display (all-the-icons-material "link" :face 'org-roam-dim :height 0.9)) " ")
))
)
(cl-defmethod org-roam-node-functiontag ((node org-roam-node))
"The first tag of notes are used to denote note type"
(let* ((specialtags ag/lit-categories)
(tags (seq-filter (lambda (tag) (not (string= tag "ATTACH"))) (org-roam-node-tags node)))
(functiontag (seq-intersection specialtags tags 'string=)))
(concat
(if functiontag
(cond ((member "paper" functiontag)
(propertize "=@=" 'display (all-the-icons-faicon "file-pdf-o" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "unprocessed" functiontag)
(propertize "=@=" 'display (nerd-icons-mdicon "nf-md-circle_edit_outline" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "journal" functiontag)
(propertize "=@=" 'display (all-the-icons-faicon "clock-o" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "thesis" functiontag)
(propertize "=@=" 'display (all-the-icons-octicon "mortar-board" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "conferences" functiontag)
(propertize "=@=" 'display (all-the-icons-octicon "megaphone" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "book" functiontag)
(propertize "=@=" 'display (nerd-icons-mdicon "nf-md-book_open_page_variant_outline" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "resources" functiontag)
(propertize "=@=" 'display (nerd-icons-octicon "nf-oct-globe" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "meetings" functiontag)
(propertize "=@=" 'display (nerd-icons-octicon "nf-oct-broadcast" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "teaching" functiontag)
(propertize "=@=" 'display (nerd-icons-octicon "nf-oct-dependabot" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "projects" functiontag)
(propertize "=@=" 'display (nerd-icons-mdicon "nf-md-atom_variant" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "maestria" functiontag)
(propertize "=@=" 'display (nerd-icons-octicon "nf-oct-log" :face 'all-the-icons-dmaroon :v-adjust 0.02 :height 0.8)))
((member "research" functiontag)
(propertize "=@=" 'display (nerd-icons-powerline "nf-ple-lego_separator_thin" :face 'all-the-icons-dpurple :v-adjust 0.02 :height 0.8)))
)
(propertize "=@=" 'display (nerd-icons-faicon "nf-fa-tags" :face 'all-the-icons-dmaroon :v-adjust 0.02 :cache :height 0.7))
)
" "
(propertize (string-join functiontag ", ") 'face 'all-the-icons-lblue)
))
)
(cl-defmethod org-roam-node-othertags ((node org-roam-node))
"Return the file TITLE for the node."
(let* ((tags (seq-filter (lambda (tag) (not (string= tag "ATTACH"))) (org-roam-node-tags node)))
(specialtags ag/lit-categories)
(othertags (seq-difference tags specialtags 'string=))
)
(concat
(if othertags
(propertize "=@=" 'display "")
(propertize "= =" 'display "")
)
(propertize (string-join othertags ", ") 'face 'all-the-icons-lorange))
))
(cl-defmethod org-roam-node-hierarchy ((node org-roam-node))
"Return the hierarchy for the node."
(let* ((title (org-roam-node-title node))
(olp (mapcar (lambda (s) (if (> (length s) 10) (concat (substring s 0 10) "...") s)) (org-roam-node-olp node)))
(level (org-roam-node-level node))
(filetitle (org-roam-get-keyword "TITLE" (org-roam-node-file node)))
(shortentitle (if (> (length filetitle) 20) (concat (substring filetitle 0 20) "...") filetitle))
(separator (concat " " (all-the-icons-octicon "chevron-right") " "))
)
(cond
((>= level 1) (concat (propertize (format "=level:%d=" level) 'display (nerd-icons-mdicon "nf-md-file_tree_outline" :face 'all-the-icons-blue))
" "
(propertize shortentitle 'face 'org-roam-dim)
(propertize separator 'face 'org-roam-dim)
title))
(t (concat (propertize (format "=level:%d=" level) 'display (nerd-icons-faicon "nf-fa-file_text" :face 'all-the-icons-yellow))
" "
title))
)
))
;; This closes the org-roam config
)(setq ag/lit-categories
'("unprocessed" "research" "book" "paper" "resources" "journal" "thesis" "meetings" "teaching" "projects" "conferences" "maestria")
)
(setq org-roam-node-display-template (concat " ${backlinkscount:8} " " ${functiontag:15} " " ${othertags:25} " " ${hierarchy:180} "))(use-package org-roam-sbl-show-broken-links
:after org-roam
:bind (:map org-roam-mode-map
(("C-c n b" . org-roam-sbl-show-broken-links)
("C-c n B" . org-roam-sbl-show-all-broken-links))))(use-package deft
:commands (deft)
:bind (("C-c n d" . deft)
("C-c n u" . ag/pick-deft-dir))
:config
(setq deft-directory org-roam-directory
deft-extensions '("md" "org")
deft-use-filename-as-title t)
;; Setup my list of deft directories
(defvar ag/deft-dir-list '()
"A list of deft directories to pick")
(setq ag/deft-dir-list '("~/orgfiles/pages"
"~/orgfiles/journals"
"~/orgfiles/bibtex"
))
(defun ag/pick-deft-dir ()
"Select directories from a list"
(interactive)
(setq deft-directory
(ido-completing-read "Select directory: " ag/deft-dir-list))
(deft-refresh))
(setq deft-strip-summary-regexp ":PROPERTIES:\n\\(.+\n\\)+\\#\\+title: ")
(setq deft-strip-title-regexp
(concat
"\\(?:^%+\\|^#\\+TITLE: *\\|^[#* ]+\\|-\\*-[[:alpha:]]+-\\*-\\|^Title:[ ]*\\|#+$\\)"
))
)
(use-package org-ref
:after org
:defer t
:init
(require 'bibtex)
(require 'org-ref-ivy)
;; Following JKitchin config in scimax
(require 'org-ref-arxiv)
(require 'org-ref-scopus)
(require 'org-ref-wos)
(require 'doi-utils)
(require 'org-ref-isbn)
:config
(setq org-ref-show-broken-links t)
)(use-package org-roam-bibtex
:after org
:defer t
:bind (("C-c b d" . doi-add-bibtex-entry)
("C-c b a" . arxiv-get-pdf-add-bibtex-entry)
("C-c b k" . org-ref-clean-bibtex-entry))
:custom
(org-roam-bibtex-mode 1)
:config
(require 'org-ref)
(setq orb-preformat-keywords
'("citekey" "author" "year" "title" "keywords" "file" "doi" "journal" "abstract")
orb-process-file-keyword t
orb-file-field-extensions '("pdf"))
)
(org-link-set-parameters "zotero" :follow
(lambda (zpath)
(browse-url
(format "zotero:%s" zpath)
)))Based on nalhasan’s configuration.
(use-package pdf-tools
:init
(pdf-loader-install)
:config
(setq-default pdf-view-display-size 'fit-page)
(define-key pdf-view-mode-map (kbd "C-s") 'isearch-forward)
(add-hook 'pdf-view-mode-hook (lambda () (cua-mode 0)))
(define-key pdf-view-mode-map (kbd "h") 'pdf-annot-add-highlight-markup-annotation)
(define-key pdf-view-mode-map (kbd "t") 'pdf-annot-add-text-annotation)
(define-key pdf-view-mode-map (kbd "D") 'pdf-annot-delete)
(setq pdf-view-use-scaling t
pdf-view-use-imagemagick nil
display-line-numbers-mode 0
pdf-view-resize-factor 1.1
pdf-annot-activate-created-annotations t)
)
This gets rid of the annoying flickering cursor in pdf view mode.
(evil-set-initial-state 'pdf-view-mode 'emacs)
(add-hook 'pdf-view-mode-hook
(lambda ()
(set (make-local-variable 'evil-emacs-state-cursor) (list nil))))
(use-package org-noter
:bind (("C-c n o" . org-noter)
("C-c n q" . org-noter-kill-session))
:config
(setq org-noter-always-create-frame nil
org-noter-separate-notes-from-heading t
org-noter-default-heading-title "Page $p$"
org-noter-auto-save-last-location t
org-noter-separate-notes-from-heading t
org-noter-doc-property-in-notes t
org-noter-hide-other t
org-noter-doc-split-fraction '(.60 . .5)
org-noter-notes-search-path '(file-truename "~/orgfiles/bibtex/")
)
)
This template allows to have a noter drawer so that I can link both org roam file with a pdf.
(add-to-list 'org-roam-capture-templates
'("r" "reading notes" plain
(file "~/.emacs.d/templates/org-capture/reading-notes")
:if-new
(file+head
"bibtex/%<%Y%m%d>-${citekey}.org"
"#+title: ${title}\n")
:unnarrowed t
:jump-to-captured t)
)This is a particular use case in my worflow.
(add-to-list 'org-roam-capture-templates
'("r" "revision" plain
(file "~/.emacs.d/templates/org-capture/thesis-revision")
:if-new
(file+head
"bibtex/%<%Y%m%d>-${citekey}.org"
"#+title: ${title}\n")
:unnarrowed t)
)(add-to-list 'org-roam-capture-templates
'("m" "mathematics" plain
(file "~/.emacs.d/templates/org-capture/concept-template")
:if-new
(file+head
"pages/%<%Y%m%d%H%M%S>-${slug}.org"
"#+title: ${title}\n")
:unnarrowed t)
)(add-to-list 'org-roam-capture-templates
'("n" "notes" plain
(file "~/.emacs.d/templates/org-capture/notes-template")
:if-new
(file+head
"pages/%<%Y%m%d%H%M%S>-${slug}.org"
"#+title: ${title}\n")
:unnarrowed t)
)(setq directory-abbrev-alist
'(
("~/Google Drive" . "~/Library/CloudStorage/[email protected]/My Drive")
("/Users/agarbuno/bibliography" . "~/Library/CloudStorage/[email protected]/My Drive/3-resources/bibliography")
)
)(use-package org-sticky-header
:hook (org-mode . org-sticky-header-mode)
:config
;; Show full path in header
(setq org-sticky-header-full-path 'full)
;; Use > instead of / as separator
(setq org-sticky-header-outline-path-separator " > ")
)Use org-make-toc to automatically update the ToC in any header with a property named TOC.
(use-package org-make-toc
:hook (org-mode . org-make-toc-mode))
(use-package org-web-tools
:after org
:bind
("C-c n l" . org-web-tools-insert-link-for-url)
)
We use the excellent lsp-mode to enable IDE-like functionality for many different programming languages via “language servers” that speak the Language Server Protocol. Before trying to set up lsp-mode for a particular language, check out the documentation for your language so that you can learn which language servers are available and how to install them.
The lsp-keymap-prefix setting enables you to define a prefix for where lsp-mode’s default keybindings will be added. I highly recommend using the prefix to find out what you can do with lsp-mode in a buffer.
The which-key integration adds helpful descriptions of the various keys so you should be able to learn a lot just by pressing C-c l in a lsp-mode buffer and trying different things that you find there.
(defun ag/lsp-mode-setup ()
(setq lsp-headerline-breadcrumb-segments '(path-up-to-project file symbols))
(setq lsp-pyls-disable-warning t)
(lsp-headerline-breadcrumb-mode)
)
(use-package lsp-mode
:commands (lsp lsp-deferred)
:init
(setq lsp-keymap-prefix "C-c l") ;; Or 'C-l', 's-l'
:hook (lsp-mode . ag/lsp-mode-setup)
:config
(setq lsp-enable-which-key-integration t)
(setq lsp-auto-guess-root nil)
(setq lsp-prefer-flymake nil) ; Use flycheck instead of flymake
(setq lsp-file-watch-threshold nil)
(setq read-process-output-max (* 1024 1024))
(setq lsp-diagnostics-provider :none)
(setq lsp-eldoc-hook nil)
(setq flycheck-mode nil)
(setq lsp-signature-auto-activate nil)
(setq lsp-signature-render-documentation nil)
)
lsp-ui is a set of UI enhancements built on top of lsp-mode which make Emacs feel even more like an IDE. Check out the screenshots on the lsp-ui homepage (linked at the beginning of this paragraph) to see examples of what it can do.
(use-package lsp-ui
:hook (lsp-mode . lsp-ui-mode)
:custom
(lsp-ui-doc-enable nil)
(lsp-ui-doc-position 'bottom)
(lsp-ui-doc-delay .1)
)
lsp-treemacs provides nice tree views for different aspects of your code like symbols in a file, references of a symbol, or diagnostic messages (errors and warnings) that are found in your code.
Try these commands with M-x:
lsp-treemacs-symbols- Show a tree view of the symbols in the current filelsp-treemacs-references- Show a tree view for the references of the symbol under the cursorlsp-treemacs-error-list- Show a tree view for the diagnostic messages in the project
This package is built on the treemacs package which might be of some interest to you if you like to have a file browser at the left side of your screen in your editor.
(use-package lsp-treemacs
:after lsp)
lsp-ivy integrates Ivy with lsp-mode to make it easy to search for things by name in your code. When you run these commands, a prompt will appear in the minibuffer allowing you to type part of the name of a symbol in your code. Results will be populated in the minibuffer so that you can find what you’re looking for and jump to that location in the code upon selecting the result.
Try these commands with M-x:
lsp-ivy-workspace-symbol- Search for a symbol name in the current project workspacelsp-ivy-global-workspace-symbol- Search for a symbol name in all active project workspaces
(use-package lsp-ivy
:after lsp)
install.packages("languageserver")
Company Mode provides a nicer in-buffer completion interface than completion-at-point which is more reminiscent of what you would expect from an IDE. We add a simple configuration to make the keybindings a little more useful (TAB now completes the selection and initiates completion at the current location if needed).
We also use company-box to further enhance the look of the completions with icons and better overall presentation.
(use-package company
:after lsp-mode
:hook ((lsp-mode . company-mode)
(ess-r-mode . company-mode)
(LaTeX-mode . company-mode))
:bind
(:map company-active-map
("<tab>" . company-complete-selection))
(:map lsp-mode-map
("<tab>" . company-indent-or-complete-common))
:custom
(company-minimum-prefix-length 1)
(company-idle-delay 0.0)
(company-tooltip-align-annotations t)
(company-selection-wrap-around t)
;; This might control my problems with R
(company-tooltip-maximum-width 60)
(company-tooltip-minimum-width 60)
)
(use-package company-box
:hook (company-mode . company-box-mode))As of today, yasnippets is not bundled with snippets directly. You need to install yasnippets-snippets.
(use-package yasnippet
:config
(setq yas-snippet-dirs (append yas-snippet-dirs
'("~/.emacs.d/templates/snippets/")))
(yas-reload-all)
(setq yas-triggers-in-field t)
:init
(yas-global-mode 1)
)
(use-package yasnippet-snippets
:after yasnippet
:config
(yasnippet-snippets-initialize)
)
(defun ag/org-latex-yas ()
"Activate org and LaTeX yas expansion in org-mode buffers."
(yas-minor-mode)
(yas-activate-extra-mode 'latex-mode))
(add-hook 'org-mode-hook #'ag/org-latex-yas)
We use lsp-mode and dap-mode to provide a more complete development environment for Python in Emacs. Check out the pyls configuration in the lsp-mode documentation for more details.
Make sure you have the pyls language server installed before trying lsp-mode!
# pip install --user "python-language-server[all]"
pip install python-lsp-server
There are a number of other language servers for Python so if you find that pyls doesn’t work for you, consult the lsp-mode language configuration documentation to try the others!
(use-package python-black
:demand t
:after python-mode
:hook (python-mode . python-black-on-save-mode-enable-dwim))
(setenv "WORKON_HOME" "~/anaconda3/envs")
(use-package pyvenv
:after python-mode
:config
(pyvenv-mode 1)
(pyvenv-activate "~/anaconda3"))
I found this quite useful for understanding emacs as a python IDE.
(use-package elpy
:after python-mode
:ensure t
:config
(setq elpy-shell-starting-directory 'current-directory
python-shell-interpreter "python3"
python-shell-interpreter-args "-i"
elpy-rpc-virtualenv-path 'current)
(add-to-list 'python-shell-completion-native-disabled-interpreters
"python")
:init
(elpy-enable))
Shamelessly porting config from skalas (he knows).
(use-package python-django
:after python-mode)
(use-package poetry
:after python-mode)
(use-package sphinx-doc
:after python-mode
:config (sphinx-doc-mode t))
(use-package python-mode
:ensure t)
Note I am using lsp-jedi as pyls seems to be deprecated. The instructions to install it are as follows
First install
pip install jedi json-rpc service_factory virtualenvM-x package-install lsp-jedi
M-x jedi:install-serverand enable jedi:setup or jedi:ac_setup in the buffer.
(use-package lsp-jedi
:ensure t
:config
(with-eval-after-load "lsp-mode"
(add-to-list 'lsp-disabled-clients 'pyls)
(add-to-list 'lsp-enabled-clients 'jedi)))
(use-package dap-mode)
(use-package python-mode
:ensure t
:hook (python-mode . lsp)
:custom
;; NOTE: Set these if Python 3 is called "python3" on your system!
;; (python-shell-interpreter "python3")
;; (dap-python-executable "python3")
(dap-python-debugger 'debugpy)
:config
(require 'dap-python))
(defun ag/insert-r-pipe ()
"R - %>% operator or 'then' pipe operator"
(interactive)
(just-one-space 1)
(insert "|>")
(reindent-then-newline-and-indent))
(use-package ess
:defer t
:commands R
:bind (
:map ess-mode-map
("C-<" . ess-insert-assign)
("C->" . ag/insert-r-pipe)
:map inferior-ess-mode-map
("C-<" . ess-insert-assign)
("C->" . ag/insert-r-pipe)
)
:init
(load "ess-site")
:custom
(setq ess-eval-visibly 'nowait)
(setq ess-use-flymake nil)
)
(defun my-inferior-ess-init ()
(setq-local ansi-color-for-comint-mode 'filter)
(smartparens-mode 1))
(add-hook 'inferior-ess-mode-hook 'my-inferior-ess-init)(use-package poly-R
:config
(defun ag/insert-rmd-chunk (language)
"Insert an r-chunk in markdown mode. Necessary due to interactions between polymode and yasnippet"
(interactive "sLanguage: ")
(insert (concat "```{" language "}\n\n```"))
(forward-line -1))
(define-key poly-markdown+r-mode-map (kbd "M-n M-i") #'ag/insert-rmd-chunk)
)
(defun ag/markdown-latex-yas ()
"Activate org and LaTeX yas expansion in org-mode buffers."
(yas-minor-mode)
(yas-activate-extra-mode 'latex-mode))
(add-hook 'markdown-mode-hook #'ag/markdown-latex-yas)
(use-package stan-mode
:mode ("\\.stan\\'" . stan-mode)
:hook (stan-mode . stan-mode-setup)
;;
:config
;; The officially recommended offset is 2.
(setq stan-indentation-offset 2))
;;; company-stan.el
(use-package company-stan
:hook (stan-mode . company-stan-setup)
;;
:config
;; Whether to use fuzzy matching in `company-stan'
(setq company-stan-fuzzy nil))
;;; eldoc-stan.el
(use-package eldoc-stan
:hook (stan-mode . eldoc-stan-setup)
;;
:config
;; No configuration options as of now.
)
;;; flycheck-stan.el
(use-package flycheck-stan
;; Add a hook to setup `flycheck-stan' upon `stan-mode' entry
:hook ((stan-mode . flycheck-stan-stanc2-setup)
(stan-mode . flycheck-stan-stanc3-setup))
:config
;; A string containing the name or the path of the stanc2 executable
;; If nil, defaults to `stanc2'
(setq flycheck-stanc-executable nil)
;; A string containing the name or the path of the stanc2 executable
;; If nil, defaults to `stanc3'
(setq flycheck-stanc3-executable nil))
;;; stan-snippets.el
(use-package stan-snippets
:hook (stan-mode . stan-snippets-initialize)
;;
:config
;; No configuration options as of now.
)
(use-package yaml-mode
:custom
(add-to-list 'auto-mode-alist '("\\.yml\\'" . yaml-mode))
)
I recommend watching “Emacs IDE - How to Debug Your Code with dap-mode” to learn more about the features!
Configuration instructions: https://emacs-lsp.github.io/dap-mode/page/configuration/#python
However, we will use debugpy (ptvsd is deprecated):
pip install debugpy
Run dap-debug and select the pytest configuration. Fails due to python2!
Set dap-python-executable to python3
Running the default pytest configuration doesn’t launch from the correct path, let’s edit the configuration with dap-debug-edit-template:
(dap-register-debug-template
"Python :: Run pytest (gallery-dl)"
(list :type "python"
:cwd "/home/daviwil/Projects/Code/gallery-dl"
:module "pytest"
:request "launch"
:debugger 'debugpy
:name "Python :: Run pytest (gallery-dl)"))
However, this still doesn’t work correctly from within a file in the project folder. dap-mode bug?
Emacs’ built in commenting functionality comment-dwim (usually bound to M-;) doesn’t always comment things in the way you might expect so we use evil-nerd-commenter to provide a more familiar behavior. I’ve bound it to M-/ since other editors sometimes use this binding but you could also replace Emacs’ M-; binding with this command.
(use-package evil-nerd-commenter
:bind ("M-/" . evilnc-comment-or-uncomment-lines))
Projectile is a project management library for Emacs which makes it a lot easier to navigate around code projects for various languages. Many packages integrate with Projectile so it’s a good idea to have it installed even if you don’t use its commands directly.
(use-package projectile
:diminish projectile-mode
:config (projectile-mode)
:custom ((projectile-completion-system 'ivy))
:bind-keymap
("C-c p" . projectile-command-map)
:init
;; NOTE: Set this to the folder where you keep your Git repos!
(when (file-directory-p "~/github-repos")
(setq projectile-project-search-path '("~/github-repos")))
(setq projectile-switch-project-action #'projectile-dired))
(use-package counsel-projectile
:after projectile
:config (counsel-projectile-mode))
(use-package treemacs
:ensure t
:defer t
:config
(treemacs-git-mode 'simple)
)
(use-package treemacs-evil
:after (treemacs evil)
:ensure t)
(use-package treemacs-projectile
:after (treemacs projectile)
)
(use-package treemacs-perspective
:after (treemacs perspective)
:ensure t
:config (treemacs-set-scope-type 'Perspectives))
Magit is the best Git interface I’ve ever used. Common Git operations are easy to execute quickly using Magit’s command panel system.
(use-package magit
:commands magit-status
:custom
(magit-display-buffer-function #'magit-display-buffer-same-window-except-diff-v1)
(add-hook 'text-mode-hook 'disable-evil-mode)
)
(use-package treemacs-magit
:after (treemacs magit)
:ensure t
)
;; NOTE: Make sure to configure a GitHub token before using this package!
;; - https://magit.vc/manual/forge/Token-Creation.html#Token-Creation
;; - https://magit.vc/manual/ghub/Getting-Started.html#Getting-Started
(use-package forge
:after magit)
(use-package git-timemachine
:after magit
:config
(setq git-timemachine-abbreviation-length 4)
)
(setq ediff-window-setup-function 'ediff-setup-windows-plain)rainbow-delimiters is useful in programming modes because it colorizes nested parentheses and brackets according to their nesting depth. This makes it a lot easier to visually match parentheses in Emacs Lisp code without having to count them yourself.
(use-package rainbow-delimiters
:hook (prog-mode . rainbow-delimiters-mode))
Let us have some syntax coloring.
(use-package dockerfile-mode)term-mode is a built-in terminal emulator in Emacs. Because it is written in Emacs Lisp, you can start using it immediately with very little configuration. If you are on Linux or macOS, term-mode is a great choice to get started because it supports fairly complex terminal applications (htop, vim, etc) and works pretty reliably. However, because it is written in Emacs Lisp, it can be slower than other options like vterm. The speed will only be an issue if you regularly run console apps with a lot of output.
One important thing to understand is line-mode versus char-mode. line-mode enables you to use normal Emacs keybindings while moving around in the terminal buffer while char-mode sends most of your keypresses to the underlying terminal. While using term-mode, you will want to be in char-mode for any terminal applications that have their own keybindings. If you’re just in your usual shell, line-mode is sufficient and feels more integrated with Emacs.
With evil-collection installed, you will automatically switch to char-mode when you enter Evil’s insert mode (press i). You will automatically be switched back to line-mode when you enter Evil’s normal mode (press ESC).
Run a terminal with M-x term!
Useful key bindings:
C-c C-p/C-c C-n- go back and forward in the buffer’s prompts (also[[and]]with evil-mode)C-c C-k- Enter char-modeC-c C-j- Return to line-mode- If you have
evil-collectioninstalled,term-modewill enter char mode when you use Evil’s Insert mode
(use-package term
:commands term
:config
(setq explicit-shell-file-name "zsh") ;; Change this to zsh, etc
(setq explicit-zsh-args '()) ;; Use 'explicit-<shell>-args for shell-specific args
;; Match the default Bash shell prompt. Update this if you have a custom prompt
(setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *"))
The eterm-256color package enhances the output of term-mode to enable handling of a wider range of color codes so that many popular terminal applications look as you would expect them to. Keep in mind that this package requires ncurses to be installed on your machine so that it has access to the tic program. Most Linux distributions come with this program installed already so you may not have to do anything extra to use it.
(use-package eterm-256color
:hook (term-mode . eterm-256color-mode))
vterm is an improved terminal emulator package which uses a compiled native module to interact with the underlying terminal applications. This enables it to be much faster than term-mode and to also provide a more complete terminal emulation experience.
Make sure that you have the necessary dependencies installed before trying to use vterm because there is a module that will need to be compiled before you can use it successfully.
(use-package vterm
:after evil-collection
:commands vterm
:config
(setq term-prompt-regexp "^[^#$%>\n]*[#$%>] *") ;; Set this to match your custom shell prompt
;;(setq vterm-shell "zsh") ;; Set this to customize the shell to launch
(setq vterm-max-scrollback 10000))
shell-mode is a middle ground between term-mode and Eshell. It is not a terminal emulator so more complex terminal programs will not run inside of it. It does have much better integration with Emacs because all command input in this mode is handled by Emacs and then sent to the underlying shell once you press Enter. This means that you can use evil-mode’s editing motions on the command line, unlike in the terminal emulator modes above.
Useful key bindings:
C-c C-p/C-c C-n- go back and forward in the buffer’s prompts (also[[and]]with evil-mode)M-p/M-n- go back and forward in the input historyC-c C-u- delete the current input string backwards up to the cursorcounsel-shell-history- A searchable history of commands typed into the shell
One advantage of shell-mode on Windows is that it’s the only way to run cmd.exe, PowerShell, Git Bash, etc from within Emacs. Here’s an example of how you would set up shell-mode to run PowerShell on Windows:
(when (eq system-type 'windows-nt)
(setq explicit-shell-file-name "powershell.exe")
(setq explicit-powershell.exe-args '()))
C-x dorC-x C-f-direddired-jump- open Dired buffer, select the current fileprojectile-dired
Emacs / Evil
n/j- next linep/k- previous linej/J- jump to file in bufferRET- select file or directory^- go to parent directoryS-RET/g O- Open file in “other” windowM-RET- Show file in other window without focusing (previewing files)g o(dired-view-file) - Open file but in a “preview” mode, close withq
(use-package dired
:ensure nil
:commands (dired dired-jump)
:bind (("C-x C-j" . dired-jump))
:config
(evil-collection-define-key 'normal 'dired-mode-map
"h" 'dired-single-up-directory
"l" 'dired-single-buffer))
(use-package dired-single
:after dired)
(use-package all-the-icons-dired
:after dired
:config
(setq all-the-icons-dired-monochrome nil))m- Marks a fileu- Unmarks a fileU- Unmarks all files in buffer* t/t- Inverts marked files in buffer% m- Mark files in buffer using regular expression*- Lots of other auto-marking functionsk/K- “Kill” marked items (refresh buffer withg/g rto get them back)- Many operations can be done on a single file if there are no active marks!
C- Copy marked files (or if no files are marked, the current file)- Copying single and multiple files
U- Unmark all files in bufferR- Rename marked files, renaming multiple is a move!% R- Rename based on regular expression:^test,old-\&
D- Delete marked filed- Mark file for deletionx- Execute deletion for marksdelete-by-moving-to-trash- Move to trash instead of deleting permanently
Z- Compress or uncompress a file or folder to (.tar.gz)c- Compress selection to a specific filedired-compress-files-alist- Bind compression commands to file extension
T- Touch (change timestamp)M- Change file modeO- Change file ownerG- Change file groupS- Create a symbolic link to this fileL- Load an Emacs Lisp file into Emacs
(use-package all-the-icons-dired
:after dired
:hook (dired-mode . all-the-icons-dired-mode))
!or&to launch an external program on a file
(use-package dired-open
:after dired
:config
;; Doesn't work as expected!
(add-to-list 'dired-open-functions #'dired-open-xdg t)
;; -- OR! --
(setq dired-open-extensions '(("png" . "preview")
("mkv" . "preview"))))
(use-package dired-hide-dotfiles
:hook (dired-mode . dired-hide-dotfiles-mode)
:config
(evil-collection-define-key 'normal 'dired-mode-map
"H" 'dired-hide-dotfiles-mode))
Each item lists the default Emacs binding followed by the evil-mode binding. Note that many of the evil-mode bindings also allow you to use Ctrl with the second key in the sequence!
| Command | Key | Description |
|---|---|---|
delete-window | C-x 0 | Close the current window |
delete-other-windows | C-x 1 | Close all other windows |
split-window-below | C-x 2 | Split the current window horizonally |
split-window-right | C-x 3 | Split the current window vertically |
shrink-window-horizontally | C-x { | Make the window smaller horizontally |
enlarge-window-horizontally | C-x } | Make the window bigger horizontally |
shrink-window | None! | Shrink the window vertically |
shrink-window-if-larger-than-buffer | C-x - | Shrink the window vertically to buffer |
balance-windows | C-x + | Balance the sizes of all windows |
TIP: You can use C-u (universal-argument) and a numeric prefix before running the shrink and enlarge commands to dictate the mount by which the window is resized.
| Command | Key | Description |
|---|---|---|
evil-window-delete | C-w C-c | Close the current window |
delete-other-windows | C-w C-o | Close all other windows |
evil-window-split | C-w C-s | Split the current window horizontally |
evil-window-vsplit | C-w C-v | Split the current window vertically |
evil-window-set-width | C-w (pipe) | Use numeric prefix to set window width |
evil-window-set-height | C-w _ | Use numeric prefix to set window height |
balance-windows | C-w = | Balance the sizes of all windows |
TIP: You can use a numeric argument before running evil-window-set-width and evil-window-set-height to specify the desired size of the window.
| Command | Keys | Description |
|---|---|---|
evil-window-next | C-w C-w | Select the next visible window |
evil-window-prev | C-w W | Select the previous visible window |
ffap-other-window | C-w C-f | Open a file in another window |
Commands to switch focus on windows
evil-window-left-C-w hevil-window-right-C-w levil-window-up-C-w kevil-window-down-C-w j;; For macOS type of keybindings (global-set-key (kbd "<M-s-up>") 'evil-window-up) (global-set-key (kbd "<M-s-down>") 'evil-window-down) (global-set-key (kbd "<M-s-left>") 'evil-window-left) (global-set-key (kbd "<M-s-right>") 'evil-window-right)
Use buffer-move for a more general solution:
buf-move: Turn on a mode where you can move the current buffer around with arrow keys, any other key finishes itbuf-move-leftbuf-move-rightbuf-move-upbuf-move-down
(use-package buffer-move
:custom
(buffer-move-stay-after-swap t)
)
(global-set-key (kbd "<C-s-up>") 'buf-move-up)
(global-set-key (kbd "<C-s-down>") 'buf-move-down)
(global-set-key (kbd "<C-s-left>") 'buf-move-left)
(global-set-key (kbd "<C-s-right>") 'buf-move-right)
winner-mode provides useful functions for undoing and redoing window configurations:
winner-undo(C-c leftorC-w ubound below)winner-redo(C-c rightorC-w Ubound below)
(use-package winner-mode
:ensure nil
:bind (:map evil-window-map
("u" . winner-undo)
("U" . winner-redo))
:config
(winner-mode))
This mode shows numbers in your windows’ mode lines to tell you what keys you can press after using the key binding C-x w. Check out the winum-mode page for more useful tips!
(use-package winum
:config
(winum-mode))
Based on:
(defun ag/latex-mode-visual-fill ()
(setq fill-column 80)
(display-fill-column-indicator-mode 1)
)
(use-package auctex-latexmk
:ensure t
:config
(auctex-latexmk-setup)
(setq auctex-latexmk-inherit-TeX-PDF-mode t))
(use-package company-auctex
:ensure t
:init (company-auctex-init))
(use-package latex
:ensure auctex
:hook (LaTeX-mode . ag/latex-mode-visual-fill)
:custom
(reftex-plug-into-AUCTeX t)
(reftex-default-bibliography '("~/orgfiles/references/bibliography.bib"))
(LaTeX-indent-level 4
LaTeX-item-indent 0
TeX-brace-indent-level 4
TeX-newline-function 'newline-and-indent)
:config
(setq font-latex-match-reference-keywords
'(
("cite" "[{")
("citep" "[{")
("cite*" "[{")
)
)
(setq TeX-parse-self t
TeX-auto-save t)
;; Prevent superscripts and subscripts from being displayed in a
;; different font size.
(setq font-latex-fontify-script nil)
;; Prevent section headers from being displayed in different font
;; sizes.
(setq font-latex-fontify-sectioning 1)
;; Don't be afraid to break inline math between lines.
(setq LaTeX-fill-break-at-separators nil)
(setq TeX-source-correlate-method 'synctex)
(add-hook 'LaTeX-mode-hook 'TeX-source-correlate-mode)
;; Use pdf-tools to open PDF files
(setq TeX-view-program-selection '((output-pdf "PDF Tools"))
TeX-source-correlate-start-server t)
;; Update PDF buffers after successful LaTeX runs
(add-hook 'TeX-after-compilation-finished-functions
#'TeX-revert-document-buffer)
)
(add-hook 'LaTeX-mode-hook (lambda ()
(push
'("Latexmk (ag)" "latexmk -pdf %s" TeX-run-command nil t
:help "Run Latexmk on file")
TeX-command-list)))Use mic-paren to highlight parehthesis for math environments in latex.
(use-package mic-paren
:after latex
:config
(add-hook 'LaTeX-mode-hook
(lambda ()
(font-lock-add-keywords nil
'(("\\\\alpha" 0 font-lock-warning-face t)))
))
)(use-package smartparens
:custom
(smartparens-global-strict-mode nil)
(smartparens-gobael-mode t)
:config
(sp-local-pair 'org-mode "$" "$")
(sp-local-pair 'markdown-mode "$" "$")
(sp-local-pair 'org-mode "~" "~")
)
(add-hook 'org-mode-hook 'smartparens-mode)
(add-hook 'markdown-mode-hook 'smartparens-mode)
(use-package bibtex
:defer t ; built-in with Emacs
:bind (("C-c b s" . bibtex-sort-buffer))
:custom
(bibtex-autokey-titleword-length 0)
(bibtex-autokey-titleword-separator "")
(bibtex-autokey-titlewords 0)
(bibtex-autokey-year-length 4)
(bibtex-autokey-year-title-separator "")
(bibtex-align-at-equal-sign t)
(bibtex-autokey-name-case-convert-function 'capitalize)
:config
(defun ag/bibtex-generate-autokey ()
(interactive)
;; first we delete the existing key
(bibtex-beginning-of-entry)
(re-search-forward bibtex-entry-maybe-empty-head)
(if (match-beginning bibtex-key-in-head)
(delete-region (match-beginning bibtex-key-in-head)
(match-end bibtex-key-in-head)))
(let* ((names (bibtex-autokey-get-names))
(year (bibtex-autokey-get-year))
(existing-keys (bibtex-parse-keys))
key)
(setq key (format "%s%s" names year))
(let ((ret key))
(cl-loop for c
from ?b to ?z
while (assoc ret existing-keys)
do (setq ret (format "%s%c" key c)))
ret)))
(advice-add #'bibtex-generate-autokey :override #'ag/bibtex-generate-autokey)
)
This can be helpful for further configuring and enabling ebib when exporting from org files into latex.
(use-package ivy-bibtex
:bind (("C-c b f" . ivy-bibtex)
("C-c b n" . ivy-bibtex-with-notes)
("C-c b ]" . org-ref-cite-insert-ivy)
("C-c b h" . org-ref-bibtex-hydra/body)
)
:config
(setq bibtex-completion-bibliography
'("~/orgfiles/references/bibliography.bib"))
(setq bibtex-completion-library-path "~/orgfiles/references/bibtex-pdfs/"
bibtex-completion-notes-path "~/orgfiles/bibtex/")
(setq bibtex-completion-pdf-field "file")
(setq bibtex-completion-pdf-symbol "⌘")
(setq bibtex-completion-notes-symbol "✎")
(setq ivy-bibtex-default-action 'ivy-bibtex-insert-citation)
(setq bibtex-completion-additional-search-fields '(booktitle))
(setq bibtex-completion-display-formats
'((article . "${=has-pdf=:1}${=has-note=:1} ${=type=:7} ${year:4} ${author:36} ${title:*} ${journal:40}")
(inbook . "${=has-pdf=:1}${=has-note=:1} ${=type=:7} ${year:4} ${author:36} ${title:*} Chapter ${chapter:32}")
(incollection . "${=has-pdf=:1}${=has-note=:1} ${=type=:7} ${year:4} ${author:36} ${title:*} ${booktitle:40}")
(inproceedings . "${=has-pdf=:1}${=has-note=:1} ${=type=:7} ${year:4} ${author:36} ${title:*} ${booktitle:40}")
(t . "${=has-pdf=:1}${=has-note=:1} ${=type=:7} ${year:4} ${author:36} ${title:*}"))
)
(defun bibtex-completion-format-citation-org-cite-original (keys)
"Format org-links using Org mode's own cite syntax."
(format "citep:%s"
(s-join ";"
(--map (format "%s" it) keys))))
(setq bibtex-completion-format-citation-functions
'((org-mode . bibtex-completion-format-citation-org-cite-original)
(latex-mode . bibtex-completion-format-citation-cite)
(markdown-mode . bibtex-completion-format-citation-pandoc-citeproc)
(default . bibtex-completion-format-citation-default)))
)(setq bibtex-completion-display-formats
'((t . "${collection:7}${=has-pdf=:1}${=has-note=:1} ${=type=:7} ${year:4} ${author:36} ${title:*} ${keywords:31}"))
)(setq bibtex-completion-additional-search-fields '(collection keywords))(defun ag/ivy-toggle-mark ()
"Toggle the mark"
(interactive)
(if (ivy--marked-p)
(ivy-unmark)
(ivy-mark))
(ivy-previous-line))
(define-key ivy-minibuffer-map (kbd "M-TAB")
#'ag/ivy-toggle-mark)(use-package reftex
:after auctex
:config
(add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
(setq reftex-save-parse-info t
reftex-enable-partial-scans t
reftex-use-multiple-selection-buffers t
reftex-plug-into-AUCTeX t
reftex-vref-is-default t
reftex-cite-format
'((?\C-m . "\\cite[]{%l}")
(?t . "\\textcite{%l}")
(?a . "\\autocite[]{%l}")
(?p . "\\parencite{%l}")
(?f . "\\footcite[][]{%l}")
(?F . "\\fullcite[]{%l}")
(?x . "[]{%l}")
(?X . "{%l}"))
font-latex-match-reference-keywords
'(("cite" "[{")
("citep" "[{")
("cites" "[{}]")
("footcite" "[{")
("footcites" "[{")
("parencite" "[{")
("textcite" "[{")
("fullcite" "[{")
("citetitle" "[{")
("citetitles" "[{")
("headlessfullcite" "[{"))
reftex-cite-prompt-optional-args nil
reftex-cite-cleanup-optional-args t))(defun use-short-bib-file ()
(interactive)
(setq bibtex-completion-bibliography '("~/orgfiles/references/bibliography.bib"))
(message "Using short bibliography file."))
(defun use-large-bib-file ()
(interactive)
(setq bibtex-completion-bibliography '("~/orgfiles/references/bibliography-all.bib"))
(message "Using large bibliography file."))(use-package citar
:custom
(citar-bibliography '("~/orgfiles/references/bibliography.bib"))
(org-cite-global-bibliography '("~/orgfiles/references/bibliography.bib"))
)
(setq citar-templates
'((main . "${author editor:30%sn} ${date year issued:4} ${title:48}")
(suffix . " ${=key= id:15} ${=type=:12} ${tags keywords:*}")
(preview . "${author editor:%etal} (${year issued date}) ${title}, ${journal journaltitle publisher container-title collection-title}.\n")
(note . "Notes on ${author editor:%etal}, ${title}")))
(setq citar-indicators
(list citar-indicator-files-icons
citar-indicator-links-icons
citar-indicator-notes-icons
citar-indicator-cited-icons)) (defvar citar-indicator-files-icons
(citar-indicator-create
:symbol (all-the-icons-faicon
"file-o"
:face 'all-the-icons-green
:v-adjust -0.1)
:function #'citar-has-files
:padding " " ; need this because the default padding is too low for these icons
:tag "has:files"))
(defvar citar-indicator-links-icons
(citar-indicator-create
:symbol (all-the-icons-octicon
"link"
:face 'all-the-icons-orange
:v-adjust 0.01)
:function #'citar-has-links
:padding " "
:tag "has:links"))
(defvar citar-indicator-notes-icons
(citar-indicator-create
:symbol (all-the-icons-material
"speaker_notes"
:face 'all-the-icons-blue
:v-adjust -0.3)
:function #'citar-has-notes
:padding " "
:tag "has:notes"))
(defvar citar-indicator-cited-icons
(citar-indicator-create
:symbol (all-the-icons-faicon
"circle-o"
:face 'all-the-icon-green)
:function #'citar-is-cited
:padding " "
:tag "is:cited"))(use-package lsp-latex
:after auctex
:defer t
:config
(add-hook 'TeX-mode-hook 'lsp)
(add-hook 'LaTeX-mode-hook 'lsp)
(add-hook 'bibtex-mode-hook 'lsp)
)
You can produce whole Latex documents within Org Mode alone. There are a bit of configurations that needs to be put in place. For starters you can use inline Latex or source blocks.
A very nice guide for writing this type of documents can be found in: Latex within OrgMode . A snippet of the template for org-latex documents can be found there and in the repo.
(setq org-format-latex-options (plist-put org-format-latex-options :scale 1.5))
(use-package org-fragtog
:config (add-hook 'org-mode-hook 'org-fragtog-mode))
;; Used to replace graphics generation of latex frags.
(use-package math-preview
:custom
;; (math-preview-command "/opt/homebrew/bin/math-preview")
(math-preview-command "/usr/local/bin/math-preview")
(math-preview-scale 1.5)
(math-preview-tex-marks-inline
'(("$" "$")))
(math-preview-tex-marks
'(("\\begin{equation}" "\\end{equation}")
("\\begin{equation*}" "\\end{equation*}")
("\\begin{align}" "\\end{align}")
("\\begin{gather}" "\\end{gather}")
("\\begin{subequations}" "\\end{subequations}")
("$$" "$$")
))
)
(add-hook 'org-mode-hook #'math-preview-all)
;; Used to get enter-ext display of latex
(use-package org-fragtog
:config
(add-hook 'org-mode-hook 'org-fragtog-mode))
(defalias #'org-latex-preview #'math-preview-at-point)
(defalias #'org-clear-latex-preview #'math-preview-clear-region)Stow is helping me to keep everything neat. I only need to configure the variable
(setenv "TEXMFHOME" "~/.texmf") First, add the style in the home of the tex configuration. In my case, in MacOS
this is /usr/local/texlive/2018/texmf-dist/tex/latex/base/. For example I really
like using the imsart article style. Which means I fisrt have to copy the .cls
and .sty files into the LaTeX home and use texhash in the terminal to include
such styles. So my custom class is
(add-to-list 'org-latex-classes
'("org-plain-latex" ;; I use this in base class in all of my org exports.
"\\documentclass{imsart}
[NO-DEFAULT-PACKAGES]
[PACKAGES]
[EXTRA]"
("\\section{%s}" . "\\section*{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")
("\\paragraph{%s}" . "\\paragraph*{%s}")
("\\subparagraph{%s}" . "\\subparagraph*{%s}")))which I need to define as the default class:
(setq org-latex-default-class "org-plain-latex")
In the end, I haven’t been able to set this properly as I have duplicated titles and author names. But if sorted out, I believe it should be something along these lines:
(setq org-latex-title-command "\n
%% Front matter ------------------------------------------------------------
%%
\\title{%t}%% Needed for export purposes (messes with the regexp)
\\begin{aug}
%%\\author{%a}
\\end{aug}
\\maketitle
%%
%% -------------------------------------------------------------------------
%%
\n\n");; This function removes the title in the preamble.
(defun my-org-latex-remove-title (str)
(replace-regexp-in-string "^\\\\title{.*}$" "" str))
(advice-add 'org-latex-template :filter-return 'my-org-latex-remove-title)(setq org-latex-title-command "\n
%% Front matter
%%
\\begin{frontmatter}
\\title{%t}
%% \\author{%a}
\\end{frontmatter}
")
Let’s define the processing for the export through latexmk:
(setq org-latex-pdf-process
'("latexmk -f -pdf -%latex -interaction=nonstopmode -output-directory=%o %f"
"pdflatex -interaction nonstopmode -output-directory %o %f"
"pdflatex -interaction nonstopmode -output-directory %o %f"))The next chunk is added for my listings configuration. Listing config can be found in here and here.
(require 'ox-latex)
(setq org-latex-packages-alist '(("" "minted")))
(setq org-latex-listings 'minted)
(setq org-latex-minted-options '(("breaklines" "true")
("breakanywhere" "true")))
(add-to-list 'org-latex-minted-langs '(R "r"))
(setq org-latex-minted-options
'(("frame" "lines")
("fontsize" "\\scriptsize")
("linenos" "")))
(setq org-latex-listings 'listings)
(setq org-latex-custom-lang-environments
'((r "r")))
(setq org-latex-listings-options
'(("frame" "single")
("backgroundcolor" "\\color{backcolour}")
("basicstyle" "\\ttfamily\\footnotesize")
("stringstyle" "\\ttfamily")
("numbers" "left")
("numberstyle" "\\tiny\\color{codegray}")
("rulecolor" "\\color{white}")
("commentsyle" "\\color{codegreen}")
))
(org-add-link-type
"latex" nil
(lambda (path desc format)
(cond
((eq format 'html)
(format "<span class=\"%s\">%s</span>" path desc))
((eq format 'latex)
(format "\\%s{%s}" path desc)))))
The following enables the exporter to use cref for clever cross-referencing commands.
(defun org-latex-ref-to-cref (text backend info)
"Use \\cref instead of \\ref in latex export."
(when (org-export-derived-backend-p backend 'latex)
(replace-regexp-in-string "\\\\ref{" "\\\\cref{" text)))
(add-to-list 'org-export-filter-final-output-functions
'org-latex-ref-to-cref)
To be able to speed-up math environments and templates in org-mode.
(use-package cdlatex
:after (tex)
:config
(add-hook 'LaTeX-mode-hook 'turn-on-cdlatex))
;; (add-hook 'org-mode-hook 'turn-on-org-cdlatex)
Configuration taken from zzamboni.org | How to insert screenshots in Org documents on macOS
(use-package org-download
:after org
:defer nil
:custom
(org-download-method 'directory)
(org-download-image-dir "images")
(org-download-heading-lvl nil)
(org-download-timestamp "%Y%m%d-%H%M%S_")
(org-download-image-attr-list '("#+attr_html: :width 800 :align center"))
(org-download-screenshot-method "/usr/local/bin/pngpaste %s")
:bind
("C-c n s" . org-download-screenshot)
:config
(require 'org-download))
(use-package flyspell-correct
:after flyspell
:bind (:map flyspell-mode-map ("C-;" . flyspell-correct-wrapper))
)
(use-package flyspell-correct-ivy
:after flyspell-correct)
(add-hook 'text-mode-hook 'flyspell-mode)
(setq pdf-view-use-scaling t
pdf-view-use-imagemagick nil)Just remember to toggle arxiv-mode to explore new or recent submissions to the
arxiv. For this remember to use the following instructions (taken from the
documentation):
To browse the daily new submissions list in a category, run M-x arxiv-read-new.
To browse the recent (weekly) submissions, run M-x arxiv-read-recent.
Use M-x arxiv-read-author to search for specific author(s).
Use M-x arxiv-search to perform a simple search on the arXiv database.
(use-package arxiv-mode
:ensure t
:config
(setq arxiv-default-bibliography "~/orgfiles/references/bibliography-arxiv.bib"
arxiv-default-download-folder "~/orgfiles/references/arxiv-pdfs/"
arxiv-default-category "stat"
arxiv-startup-with-abstract-window t)
(defun arxiv-read-load ()
"Read recent (past month) submissions of arXiv in a given category."
(interactive)
(let*
((date-end (format-time-string "%Y%m%d" (current-time)))
(date-start (format-time-string "%Y%m%d" (time-subtract (current-time) (* 30 86400))))
(category (completing-read "Select category: "
arxiv-categories nil t nil nil arxiv-default-category)))
(setq arxiv-query-info (format " Showing recent submissions in %s in the past month (%s to %s)." category date-start date-end))
(setq date-start (concat date-start "0000"))
(setq date-end (concat date-end "0000"))
(setq arxiv-entry-list (arxiv-query category date-start date-end))
(setq arxiv-query-data-list `((date-start . ,date-start) (date-end . ,date-end) (category . ,category)))
(setq arxiv-mode-entry-function 'arxiv-read-recent)
(arxiv-populate-page)))
)I need to sort out how to make use of this within org-mode by following this, this and this.
(use-package elfeed
:ensure t
:config
(setq elfeed-feeds
'(
("http://www.nature.com/nature/current_issue/rss" nature)
("http://www.sciencemag.org/rss/current.xml" science)
("http://www.nature.com/nmeth/current_issue/rss" methods)
("http://understandinguncertainty.org/rss.xml" uq) ;; no longer maintained
("http://xkcd.com/rss.xml" comics)
))
)I am using the following link to get a cool layout for the elfeed buffer.
(use-package elfeed-org
:ensure t
;; :bind (("C-c n e" . elfeed))
:config
(elfeed-org)
(setq elfeed-db-directory "~/orgfiles/feeds/database/")
(setq rmh-elfeed-org-files (list "~/orgfiles/feeds/rss-list.org"))
(setq elfeed-search-title-max-width 100)
(setq elfeed-show-entry-switch 'display-buffer)
(setq elfeed-search-remain-on-entry t)
(defface stats-elfeed-entry
`((t :background ,(color-lighten-name "palevioletred" 10)))
"Marks a relevant Elfeed entry.")
(defface ml-elfeed-entry
`((t :background ,(color-lighten-name "linen" -20)))
"Marks an important Elfeed entry.")
(defface siam-elfeed-entry
`((t :background ,(color-lighten-name "mediumturquoise" 10)))
"Marks an important Elfeed entry.")
(defface review-elfeed-entry
`((t :background ,(color-lighten-name "powderblue" 10)))
"Marks an important Elfeed entry.")
(push '(uq siam-elfeed-entry)
elfeed-search-face-alist)
(push '(review review-elfeed-entry)
elfeed-search-face-alist)
(push '(ml ml-elfeed-entry)
elfeed-search-face-alist)
(push '(stats stats-elfeed-entry)
elfeed-search-face-alist)
)(define-key elfeed-search-mode-map (kbd "i")
(lambda () (interactive)
(elfeed-search-set-filter "@6-months-ago +unread")))
(define-key elfeed-search-mode-map (kbd "o")
(lambda () (interactive)
(elfeed-search-set-filter "@2-years-old +unread")))
(define-key elfeed-search-mode-map (kbd "a")
(lambda () (interactive)
(elfeed-search-set-filter "@6-months-ago")))(use-package elfeed-score
:ensure t
:config
(progn
(elfeed-score-enable)
(define-key elfeed-search-mode-map "=" elfeed-score-map)))
(setq elfeed-search-print-entry-function #'elfeed-score-print-entry)is a simple tool to treat a tree of an org buffer as a single slide. Since each slide is displayed by simple narrowing, an editable presentation is easily achieved without restricting the functionality of Org Mode. And usage of org-tree-slide is not limited to a presentation. Three profiles are predefined for different use cases.
(defun ag/org-start-presentation ()
(interactive)
(org-tree-slide-mode 1)
(org-sticky-header-mode 0)
(setq text-scale-mode-amount 10.5)
(text-scale-mode 1)
(setq-local face-remapping-alist '((default (:height 1.5) variable-pitch)
(header-line (:height 4.5) variable-pitch)
(org-document-title (:height 1.75) org-document-title)
(org-code (:height 1.20) org-code)
(org-verbatim (:height 1.20) org-verbatim)
(org-block (:height 1.25) org-block)
(org-block-begin-line (:height 0.7) org-block)))
(setq-local org-format-latex-options (plist-put org-format-latex-options :scale 1.7))
(setq-local visual-fill-column-width 50
visual-fill-column-center-text t)
(visual-fill-column-mode 1)
(setq org-src-window-setup 'current-window)
)(defun ag/org-end-presentation ()
(interactive)
(text-scale-mode 0)
(org-sticky-header-mode 1)
(org-tree-slide-mode 0)
(setq-local face-remapping-alist '((default variable-pitch default)))
(setq-local org-format-latex-options (plist-put org-format-latex-options :scale 1.5))
(visual-fill-column-mode 1)
(setq org-src-window-setup 'split-window-below)
(org-mode-restart)
)I almost give up on org-tree-slides but the comments and solution on Issue #13 using the hide-lines package set me back on track.
(use-package hide-lines
:after org
)
(use-package org-tree-slide
:defer t
:after org
:commands org-tree-slide-mode
:config
(evil-define-key 'normal org-tree-slide-mode-map
(kbd "q") 'ag/org-end-presentation
(kbd "C-j") 'org-tree-slide-move-next-tree
(kbd "C-k") 'org-tree-slide-move-previous-tree)
(setq org-tree-slide-slide-in-effect nil
org-tree-slide-activate-message "Presentation started."
org-tree-slide-deactivate-message "Presentation ended."
org-tree-slide-header t)
(when (require 'hide-lines nil t)
(defvar ag/org-src-block-faces nil)
(defun ag/show-headers ()
(setq org-src-block-faces 'ag/org-src-block-faces)
(hide-lines-show-all))
(defun ag/hide-headers ()
(setq ag/org-src-block-faces 'org-src-block-faces)
;; (setq-local org-src-block-faces
;; '(("emacs-lisp" (:background "cornsilk"))))
(hide-lines-matching "#\\+BEGIN_SRC")
;; (hide-lines-matching "#\\+ATTR_HTML")
(hide-lines-matching "#\\+END_SRC"))
;; (hide-lines-matching "#\\+ATTR_\\(HTML\\|EXAMPLE\\|VERSE\\|QUOTE\\)")
(add-hook 'org-tree-slide-play-hook 'ag/hide-headers)
(add-hook 'org-tree-slide-stop-hook 'ag/show-headers)
(defun advice:org-edit-src-code (&optional code edit-buffer-name)
(interactive)
(ag/show-headers))
(advice-add 'org-edit-src-code :before #'advice:org-edit-src-code)
(defun advice:org-edit-src-exit ()
(interactive)
(ag/hide-headers))
(advice-add 'org-edit-src-exit :after #'advice:org-edit-src-exit))
:custom
(org-tree-slide-breadcrumbs " > ")
(org-image-actual-width nil)
)
This allows to export into reveal.js slides. More here. Problems with bibliography though…
(use-package org-re-reveal-citeproc
:after org
:config
(require 'org-re-reveal)
)
(add-to-list 'org-export-filter-paragraph-functions
#'org-re-reveal-citeproc-filter-cite)
(defun ag/org-reveal ()
(use-package ox-reveal
:custom
(org-reveal-note-key-char nil)
;; (org-reveal-root "/Users/agarbuno/software/reveal.js")
(org-reveal-root "https://cdn.jsdelivr.net/npm/reveal.js")
(setq org-reveal-mathjax t)
)
(use-package htmlize)
(require 'ox-reveal)
)