diff --git a/.emacs.d/Fonts/CONSOLA.TTF b/.emacs.d/Fonts/CONSOLA.TTF new file mode 100644 index 0000000..cd4980c Binary files /dev/null and b/.emacs.d/Fonts/CONSOLA.TTF differ diff --git a/.emacs.d/Fonts/CONSOLAB.TTF b/.emacs.d/Fonts/CONSOLAB.TTF new file mode 100644 index 0000000..0a4bebd Binary files /dev/null and b/.emacs.d/Fonts/CONSOLAB.TTF differ diff --git a/.emacs.d/Fonts/CONSOLAI.TTF b/.emacs.d/Fonts/CONSOLAI.TTF new file mode 100644 index 0000000..2162134 Binary files /dev/null and b/.emacs.d/Fonts/CONSOLAI.TTF differ diff --git a/.emacs.d/Fonts/CONSOLAZ.TTF b/.emacs.d/Fonts/CONSOLAZ.TTF new file mode 100644 index 0000000..3b51dd3 Binary files /dev/null and b/.emacs.d/Fonts/CONSOLAZ.TTF differ diff --git a/.emacs.d/init.el b/.emacs.d/init.el new file mode 100644 index 0000000..56a7040 --- /dev/null +++ b/.emacs.d/init.el @@ -0,0 +1,59 @@ +;; -*- mode: elisp -*- + +;; Bootstrap's bootstraps +;;;; bootstrap's bootstraps + +(setq user-init-file "~/Documents/projects/agares/applicationConfiguration/.emacs/init.el") +(package-initialize) +(require 'package) +(setq package-archives + '(("melpa" . "http://melpa.milkbox.net/packages/") + ("gnu" . "http://elpa.gnu.org/packages/") + ("elpy" . "http://jorgenschaefer.github.io/packages/"))) + +(unless (package-installed-p 'use-package) + (package-refresh-contents) + (package-install 'use-package)) + +(eval-when-compile + (require 'use-package)) + +;; load my files +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/org-protocol-capture-html.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/src/keychain-environment.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-generic.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-golang.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-org.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-python.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-rust.el") +(load-file "~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-social.el") + +;; load keychain (if it exists) +(when (eq system-type 'gnu/linux) + (keychain-refresh-environment) + ) + + +(custom-set-variables + ;; custom-set-variables was added by Custom. + ;; If you edit it by hand, you could mess it up, so be careful. + ;; Your init file should contain only one such instance. + ;; If there is more than one, they won't work right. + '(epg-gpg-program "/usr/local/bin/gpg") + '(global-hl-line-mode t) + '(package-selected-packages + (quote + (ob-restclient virtualenvwrapper flymake-python-pyflakes lsp-ui lsp-mode jedi znc yaml-mode which-key use-package twittering-mode try smex racer python-mode pylint py-autopep8 powershell pdf-tools outline-magic org2blog multiple-cursors magit helm flycheck-rust eyebrowse exec-path-from-shell emojify elpy ein doom-themes dockerfile-mode docker csharp-mode ansible anaconda-mode ace-window))) + '(znc-servers + (\` + (("bouncer.awful.club" 5000 t + ((freenode "blindidiotgod/freenode" + (\, znc-password)) + (OFTC "blindidiotgod/OFTC" + (\, znc-password)))))))) +(custom-set-faces + ;; custom-set-faces was added by Custom. + ;; If you edit it by hand, you could mess it up, so be careful. + ;; Your init file should contain only one such instance. + ;; If there is more than one, they won't work right. + ) diff --git a/.emacs.d/jlj-generic.el b/.emacs.d/jlj-generic.el new file mode 100644 index 0000000..7ff44cc --- /dev/null +++ b/.emacs.d/jlj-generic.el @@ -0,0 +1,175 @@ +(setq inhibit-splash-screen t) ; Disable the splash screen +;; (when (version<= "26.0.50" emacs-version ) +;; (global-display-line-numbers-mode)); show line numbers; use this instead of linum if you can + +(global-visual-line-mode t) ; turn on word-wrap globally +(menu-bar-mode -1) ; disable visual menu on emacs +(tool-bar-mode -1) ; disable toolbar + +(setq case-fold-search t) ; ignore case when searching +(fset 'yes-or-no-p 'y-or-n-p) ; make it easier to answer qs. +(set-frame-font "Consolas 12") ; set default font +(transient-mark-mode 1) ; Enable transient mark mode (highlights) +(load-theme 'manoj-dark) ; loads my favorite default theme +(global-hl-line-mode t) ; highlights the line you're on + +(setq indent-tabs-mode nil) ; always use spaces when indenting +(setq require-final-newline t) +(setq backup-directory-alist `(("." . "~/Nextcloud/Documents/org/.saves"))) +(find-file "~/Nextcloud/Documents/org/personal.org") ;open primary org file on launch +(electric-pair-mode 1) ; create paired brackets. + +;; lets you find all instance of string @ point with C-; +(use-package iedit + :ensure t) + +(when (eq system-type 'darwin) + (setq mac-command-modifier 'meta) + ;; Make emacs use a different default than the OS + ;; only really useful on work computers, but there we go. + (setq browse-url-browser-function #'browse-url-generic + browse-url-generic-program "open" + browse-url-generic-args '("-a" "Firefox"))) + +(if (eq system-type 'windows-nt) + (message "i am windows and suck") ; deal with mac command key problems + (exec-path-from-shell-copy-env "PATH")) + +;; (if (string-equal "darwin" (symbol-name system-type)) +;; (setenv "PATH" (concat "/usr/local/bin:/usr/local/sbin:" (getenv "PATH")))) + +(defun find-user-init-file () + "Edit the `user-init-file', in another window." + (interactive) + (find-file-other-window user-init-file)) +(global-set-key (kbd "C-c J") 'find-user-init-file) + +(setq user-home-file "~/Nextcloud/Documents/org/personal.org") +(defun find-user-home-file () + "Edit the `user-home-file' in this window" + (interactive) + (find-file user-home-file)) +(global-set-key (kbd "C-c C-j h") 'find-user-home-file) + +;; Custom frame management chords +(global-set-key (kbd "C-x O") 'other-frame) +(global-set-key (kbd "C-x T") 'make-frame-command) +(global-set-key (kbd "C-x W") 'delete-frame) +(global-set-key "\M-`" 'other-frame) ; mimic the way macosx switches + +(use-package helm + :ensure t + :config + (progn + (defun helm-surfraw-duck (x) + "Search duckduckgo in default browser" + (interactive "sSEARCH:") + (helm-surfraw x "duckduckgo" )) + (global-set-key (kbd "C-c s") 'helm-surfraw-duck))) + +(use-package smex + :ensure t + :config + (progn + (defadvice smex (around space-inserts-hyphen activate compile) + (let ((ido-cannot-complete-command + `(lambda () + (interactive) + (if (string= " " (this-command-keys)) + (insert ?-) + (funcall ,ido-cannot-complete-command))))) + ad-do-it)) + + (global-set-key (kbd "M-x") 'smex) + (global-set-key (kbd "M-X") 'smex-major-mode-commands) + ;; This is your old M-x. + (global-set-key (kbd "C-c C-c M-x") 'execute-extended-command))) + +(use-package try + :ensure t) + +(use-package which-key + :ensure t + :config (which-key-mode)) + +(use-package ace-window + :ensure t + :init + (progn + (global-set-key [remap other-window] 'ace-window))) + + +;; I don't remember what this does or why i have it +;; an emacs story +(use-package outline-magic + :ensure t) + + +(use-package multiple-cursors + :ensure t + :config + (progn + (global-set-key (kbd "C-S-c C-S-c") 'mc/edit-lines) + (global-set-key (kbd "C->") 'mc/mark-next-like-this) + (global-set-key (kbd "C-<") 'mc/mark-previous-like-this) + (global-set-key (kbd "C-c C-<") 'mc/mark-all-like-this))) + +(use-package flycheck + :ensure t + :init + (global-flycheck-mode t)) + +(use-package markdown-mode + :ensure t) + +(use-package pdf-tools + :ensure t + :config + (pdf-tools-install)) + +(use-package org-pdfview + :ensure t) + +(use-package magit + :ensure t) + +(require 'desktop) +(desktop-save-mode 1) +(defun jlj-desktop-save () + (interactive) + ;; Don't call desktop-save-in-desktop-dir, as it prints a message. + (if (eq (desktop-owner) (emacs-pid)) + (desktop-save desktop-dirname))) +(add-hook 'auto-save-hook 'jlj-desktop-save) + + +(setq org-reveal-root "http://cdn.jsdelivr.net/reveal.js/3.0.0/") +(setq org-reveal-mathjax t) + +(use-package ox-reveal + :ensure t) + +(use-package web-mode + :ensure t + :config + (add-to-list 'auto-mode-alist '("\\.html?\\'" . web-mode)) + (setq web-mode-engines-alist + '(("django" . "\\.html\\'"))) + (setq web-mode-ac-sources-alist + '(("css" . (ac-source-css-property)) + ("html" . (ac-source-words-in-buffer ac-source-abbrev)))) + + (setq web-mode-enable-auto-closing t) + (setq web-mode-enable-auto-quoting t)) ; this fixes the quote problem I mentioned + +(use-package powershell + :ensure t) + +(use-package lua-mode + :ensure t + :config + (autoload 'lua-mode "lua-mode" "Lua editing mode." t) + (add-to-list 'auto-mode-alist '("\\.lua$" . lua-mode)) + (add-to-list 'interpreter-mode-alist '("lua" . lua-mode))) + +(server-start) diff --git a/.emacs.d/jlj-golang.el b/.emacs.d/jlj-golang.el new file mode 100644 index 0000000..eb54123 --- /dev/null +++ b/.emacs.d/jlj-golang.el @@ -0,0 +1,6 @@ +(use-package eglot + :ensure t + :config + (add-hook 'go-mode-hook 'eglot-ensure) + (local-set-key "\C-x\C-m" 'compile) + (setq compile-command "go test -v && go vet && golint")) diff --git a/.emacs.d/jlj-init.org b/.emacs.d/jlj-init.org new file mode 100644 index 0000000..e69de29 diff --git a/.emacs.d/jlj-org.el b/.emacs.d/jlj-org.el new file mode 100644 index 0000000..0070382 --- /dev/null +++ b/.emacs.d/jlj-org.el @@ -0,0 +1,93 @@ +(use-package org + :ensure t + :config + (progn + ;;Org mode configuration + (require 'org) ; Enable Org mode + (setq ispell-program-name "/usr/local/bin/ispell") ; set flyspell's spellchecker + (add-hook 'org-mode-hook 'turn-on-flyspell) ; enable flyspell-mode in all org-mode enabled files + (setq org-src-fontify-natively t + org-src-window-setup 'current-window + org-src-strip-leading-and-trailing-blank-lines t + org-src-preserve-indentation t + org-src-tab-acts-natively t + x-selection-timeout 10 ;; this fixes a freeze when org-capture is called. lol. + org-edit-src-content-indentation 0) + + (add-hook 'org-agenda-mode-hook + (lambda () + (visual-line-mode -1) + (toggle-truncate-lines 1))) + (org-babel-do-load-languages + 'org-babel-load-languages + '((python . t) + (matlab . t) + (restclient . t) + (shell . t))) + + ;; log state changes to a drawer + (setq org-log-into-drawer t) + + ;; org-agenda configs + (setq org-habit-show-habits-only-for-today nil) + (setq org-agenda-repeating-timestamp-show-all nil) + (setq org-deadline-warning-days 1) + (setq org-global-properties + '(("Effort_ALL". "0 0:10 0:30 1:00 2:00 3:00 4:00"))) + (setq org-columns-default-format + '(("%25ITEM %TODO %3PRIORITY %TAGS"))) + +;;;; custom org mode hotkeys + (global-set-key "\C-cl" 'org-store-link) + (global-set-key "\C-ca" 'org-agenda) + (global-set-key "\C-cc" 'org-capture) + (global-set-key "\C-cb" 'org-iswitchb) + +;;;; search across agenda files when refiling: + (setq org-refile-targets '((nil :maxlevel . 9) + (org-agenda-files :maxlevel . 9))) + (setq org-outline-path-complete-in-steps nil) ; Refile in a single go + (setq org-refile-use-outline-path t) ; Show full paths for refiling + (setq org-agenda-files '("~/Nextcloud/Documents/org/")) ; add files to agenda: + + + (setq org-directory "~/Nextcloud/Documents/org/") ; define generic org capture shit + (setq org-default-notes-file (concat org-directory "/refile-beorg.org")))) + + + +;; Set up bullets +(use-package org-bullets + :ensure t + :config + (add-hook 'org-mode-hook (lambda () (org-bullets-mode 1)))) + +(use-package ob-restclient + :ensure t + :after org) + +;; configure the org protocol +(org-load-modules-maybe t) +(require 'org-protocol) +(require 'org-protocol-capture-html) +(setq org-protocol-default-template-key "w") + +(setq org-capture-templates + `(("w" "Web site" entry (file+olp "~/Nextcloud/Documents/org/webwiki.org" "links" "unsorted") + "* %c :website:\n%U %?%:initial") + ;; ... more templates here ... + ("c" "Context-include Todo" entry (file "~/Nextcloud/Documents/org/refile-beorg.org") + "* TODO %?\n%U \n '%a'" :empty-lines 1 :prepend t) + ("q" "quotes" entry (file+olp "~/Nextcloud/Documents/org/webwiki.org" "quotes") + "* %?\n%U \n " :empty-lines 1 :prepend t) + ("t" "Todo" entry (file "~/Nextcloud/Documents/org/refile-beorg.org") + "* TODO %?\n%U" :empty-lines 1 :prepend t))) + +;; configure org exporters +(require 'ox-md) + +;; org prettifiers +(setq org-agenda-format-date (lambda (date) (concat "\n" + (make-string (window-width) 9472) + "\n" + (org-agenda-format-date-aligned date)))) diff --git a/.emacs.d/jlj-python.el b/.emacs.d/jlj-python.el new file mode 100644 index 0000000..abcf4c6 --- /dev/null +++ b/.emacs.d/jlj-python.el @@ -0,0 +1,41 @@ +;; pylint is required (pip install pylint) +;; pep8 (pip install pep8) +;; don't use python-mode because JESUS. CHRIST. it throws everything off. +;; using jedi requires virtualenv to be installed +;; pipenv is mostly acceptable but i could not make a full IDE experience happen + +;; (use-package pylint +;; :ensure t) + + +;; (setq python-shell-interpreter "/usr/local/bin/python3" +;; python-shell-interpreter-args "-i") + +;; (use-package py-autopep8 +;; :ensure t +;; :config +;; (progn +;; (add-hook 'python-mode-hook 'py-autopep8-enable-on-save))) + +;; (use-package jedi +;; :ensure t +;; :init +;; (add-hook 'python-mode-hook 'jedi:setup) +;; (add-hook 'python-mode-hook 'jedi:ac-setup)) + +(use-package pipenv + :ensure t) + +(use-package eglot + :ensure t + :config + (add-hook 'python-mode-hook 'eglot-ensure)) + +;; (use-package pyvenv +;; :ensure t) +(use-package virtualenvwrapper + :ensure t + :config + (venv-initialize-interactive-shells) ;; if you want interactive shell support + (venv-initialize-eshell) ;; if you want eshell support + (setq venv-location "~/.local/share/virtualenvs/")) diff --git a/.emacs.d/jlj-rust.el b/.emacs.d/jlj-rust.el new file mode 100644 index 0000000..6eafc9f --- /dev/null +++ b/.emacs.d/jlj-rust.el @@ -0,0 +1,22 @@ +(use-package rust-mode + :ensure t + :config + (progn + (add-hook 'rust-mode-hook 'cargo-minor-mode) + (add-hook 'flycheck-mode-hook #'flycheck-rust-setup) + (add-hook 'rust-mode-hook + (lambda () + (local-set-key (kbd "C-c ") #'rust-format-buffer))) + + (setq racer-cmd "~/.cargo/bin/racer") ;; Rustup binaries PATH + (setq racer-rust-src-path "~/gitshit/rust/src") ;; Rust source code PATH + + (add-hook 'rust-mode-hook #'racer-mode) + (add-hook 'racer-mode-hook #'eldoc-mode) + (add-hook 'racer-mode-hook #'company-mode))) + +(use-package flycheck-rust + :ensure t) + +(use-package racer + :ensure t) diff --git a/.emacs.d/jlj-secrets.gpg b/.emacs.d/jlj-secrets.gpg new file mode 100644 index 0000000..9deeeee Binary files /dev/null and b/.emacs.d/jlj-secrets.gpg differ diff --git a/.emacs.d/jlj-social.el b/.emacs.d/jlj-social.el new file mode 100644 index 0000000..e969323 --- /dev/null +++ b/.emacs.d/jlj-social.el @@ -0,0 +1,61 @@ +;; This is such a pain in the dick. Its really nice to be able to chat within emacs +;; - but i think i regret not using weechat + +;; The bit about ~;(setf epa-pinentry-mode 'loopback)~ is important: +;; - uncomment if you want to only use emacs to input/manage the gpg key +;; - comment out if you want gpg to be handled through seahorse/gnome keyring. + +;; (when (eq system-type 'darwin) +;; (setf epa-pinentry-mode 'loopback)) +;; (use-package znc +;; :ensure t +;; :config +;; (progn +;; (custom-set-variables '(epg-gpg-program "/usr/local/bin/gpg")) +;; (setq auth-sources `("~/Documents/projects/agares/applicationConfiguration/.emacs/jlj-secrets.gpg")) + +;; (require 'epa) + +;; ;; handle annoying gpg shit. +;; (defun lookup-password (host user port) +;; "Lookup encrypted password given HOST, USER and PORT for service." +;; (require 'auth-source) +;; (funcall (plist-get +;; (car (auth-source-search +;; :host host +;; :user user +;; :type 'netrc +;; :port port)) +;; :secret))) + +;; (setq znc-password(lookup-password "bouncer.awful.club" "blindidiotgod/OFTC" 5000)) + +;; ;; by default, erc alerts you on any activity. I only want to hear +;; ;; about mentions of nick or keyword +;; (custom-set-variables +;; '(znc-servers +;; `(("bouncer.awful.club" 5000 t +;; ((freenode "blindidiotgod/freenode" ,znc-password) +;; (OFTC "blindidiotgod/OFTC" ,znc-password)))))) +;; (setq erc-current-nick-highlight-type 'all) +;; (setq erc-keywords '("security")) +;; (setq erc-track-exclude-types '("JOIN" "PART" "NICK" "MODE" "QUIT")) +;; (setq erc-track-use-faces t) +;; (setq erc-track-faces-priority-list +;; '(erc-current-nick-face erc-keyword-face)) +;; (setq erc-track-priority-faces-only 'all) +;; (setq erc-hide-list '("PART" "QUIT" "JOIN")) +;; (setq erc-join-buffer 'bury))) + + +;; the only thing that isn't pretty much stock is +;; - i rebound C-c C-o to open links, so it would mimic org-mode's layout. + +(use-package twittering-mode + :ensure t + :config + (progn + (setq twittering-icon-mode t) + (setq twittering-reverse-mode t) + (setq twittering-enable-unread-status-notifier t) + (with-eval-after-load "twittering-mode" (define-key twittering-mode-map (kbd "C-c C-o") `twittering-view-user-page)))) diff --git a/.emacs.d/org-protocol-capture-html.el b/.emacs.d/org-protocol-capture-html.el new file mode 100644 index 0000000..742f1e3 --- /dev/null +++ b/.emacs.d/org-protocol-capture-html.el @@ -0,0 +1,270 @@ +;;; org-protocol-capture-html.el --- Capture HTML with org-protocol + +;;; Commentary: + +;; This package captures Web pages into Org-mode using Pandoc to +;; process HTML. It can also use eww's eww-readable functionality to +;; get the main content of a page. + +;; These are the helper functions that run in Emacs. To capture pages +;; into Emacs, you can use either a browser bookmarklet or the +;; org-protocol-capture-html.sh shell script. See the README.org file +;; for instructions. + +;;; License: + +;; This program is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; This program is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with this program. If not, see . + +;;; Code: + +;;;; Require + +(require 'org-protocol) +(require 'cl) +(require 'subr-x) +(require 's) + +;;;; Vars + +(defcustom org-protocol-capture-html-demote-times 1 + "How many times to demote headings in captured pages. +You may want to increase this if you use a sub-heading in your capture template." + :group 'org-protocol-capture-html :type 'integer) + +;;;; Test Pandoc + +(defconst org-protocol-capture-html-pandoc-no-wrap-option nil + ;; Set this so it won't be unbound + "Option to pass to Pandoc to disable wrapping. Pandoc >= 1.16 +deprecates `--no-wrap' in favor of `--wrap=none'.") + +(defun org-protocol-capture-html--define-pandoc-wrap-const () + "Set `org-protocol-capture-html-pandoc-no-wrap-option'." + (setq org-protocol-capture-html-pandoc-no-wrap-option + ;; Pandoc >= 1.16 deprecates the --no-wrap option, replacing it with + ;; --wrap=none. Sending the wrong option causes output to STDERR, + ;; which `call-process-region' doesn't like. So we test Pandoc to see + ;; which option to use. + (with-temp-buffer + (let* ((process (start-process "test-pandoc" (current-buffer) "pandoc" "--dump-args" "--no-wrap")) + (limit 3) + (checked 0)) + (while (process-live-p process) + (if (= checked limit) + (progn + ;; Pandoc didn't exit in time. Kill it and raise + ;; an error. This function will return `nil' and + ;; `org-protocol-capture-html-pandoc-no-wrap-option' + ;; will remain `nil', which will cause this + ;; function to run again and set the const when a + ;; capture is run. + (set-process-query-on-exit-flag process nil) + (error "Unable to test Pandoc! Please report this bug! (include the output of \"pandoc --dump-args --no-wrap\")")) + (sleep-for 0.2) + (cl-incf checked))) + (if (and (zerop (process-exit-status process)) + (not (string-match "--no-wrap is deprecated" (buffer-string)))) + "--no-wrap" + "--wrap=none"))))) + +;;;; Direct-to-Pandoc + +(defun org-protocol-capture-html--with-pandoc (data) + "Process an org-protocol://capture-html:// URL. +This function is basically a copy of `org-protocol-do-capture', but +it passes the captured content (not the URL or title) through +Pandoc, converting HTML to Org-mode." + + ;; It would be nice to not basically duplicate + ;; `org-protocol-do-capture', but passing the data back to that + ;; function would require re-encoding the data into a URL string + ;; with Emacs after Pandoc converts it. Since we've already split + ;; it up, we might as well go ahead and run the capture directly. + + (unless org-protocol-capture-html-pandoc-no-wrap-option + (org-protocol-capture-html--define-pandoc-wrap-const)) + + (let* ((template (or (plist-get data :template) + org-protocol-default-template-key)) + (url (org-protocol-sanitize-uri (plist-get data :url))) + (type (if (string-match "^\\([a-z]+\\):" url) + (match-string 1 url))) + (title (or (org-protocol-capture-html--nbsp-to-space (string-trim (plist-get data :title))) "")) + (content (or (org-protocol-capture-html--nbsp-to-space (string-trim (plist-get data :body))) "")) + (orglink (org-make-link-string + url (if (string-match "[^[:space:]]" title) title url))) + (org-capture-link-is-already-stored t)) ; avoid call to org-store-link + + (setq org-stored-links + (cons (list url title) org-stored-links)) + (kill-new orglink) + + (with-temp-buffer + (insert content) + (if (not (zerop (call-process-region + (point-min) (point-max) + "pandoc" t t nil "-f" "html" "-t" "org" org-protocol-capture-html-pandoc-no-wrap-option))) + (message "Pandoc failed: %s" (buffer-string)) + (progn + ;; Pandoc succeeded + (org-store-link-props :type type + :annotation orglink + :link url + :description title + :orglink orglink + :initial (buffer-string))))) + (org-protocol-capture-html--do-capture) + nil)) + +(add-to-list 'org-protocol-protocol-alist + '("capture-html" + :protocol "capture-html" + :function org-protocol-capture-html--with-pandoc + :kill-client t)) + +;;;; eww-readable + +(eval-when-compile + ;; eww-readable only works on Emacs >=25.1, but I think it's better + ;; to check for the actual symbols. I think using + ;; `eval-when-compile' is the right way to do this, but I'm not + ;; sure. + (when (and (require 'eww nil t) + (require 'dom nil t) + (fboundp 'eww-score-readability)) + + (defun org-protocol-capture-html--capture-eww-readable (data) + "Capture content of URL with eww-readable.." + + (unless org-protocol-capture-html-pandoc-no-wrap-option + (org-protocol-capture-html--define-pandoc-wrap-const)) + + (let* ((template (or (plist-get data :template) + org-protocol-default-template-key)) + (url (org-protocol-sanitize-uri (plist-get data :url))) + (type (if (string-match "^\\([a-z]+\\):" url) + (match-string 1 url))) + (html (org-protocol-capture-html--url-html url)) + (result (org-protocol-capture-html--eww-readable html)) + (title (cdr result)) + (content (with-temp-buffer + (insert (org-protocol-capture-html--nbsp-to-space (car result))) + ;; Convert to Org with Pandoc + (unless (= 0 (call-process-region (point-min) (point-max) + "pandoc" t t nil "-f" "html" "-t" "org" + org-protocol-capture-html-pandoc-no-wrap-option)) + (error "Pandoc failed.")) + (save-excursion + ;; Remove DOS CR/LF line endings + (goto-char (point-min)) + (while (search-forward (string ?\C-m) nil t) + (replace-match ""))) + ;; Demote page headings in capture buffer to below the + ;; top-level Org heading and "Article" 2nd-level heading + (save-excursion + (goto-char (point-min)) + (while (re-search-forward (rx bol (1+ "*") (1+ space)) nil t) + (beginning-of-line) + (insert "**") + (end-of-line))) + (buffer-string))) + (orglink (org-make-link-string + url (if (s-present? title) title url))) + ;; Avoid call to org-store-link + (org-capture-link-is-already-stored t)) + + (setq org-stored-links + (cons (list url title) org-stored-links)) + (kill-new orglink) + + (org-store-link-props :type type + :annotation orglink + :link url + :description title + :orglink orglink + :initial content) + (org-protocol-capture-html--do-capture) + nil)) + + (add-to-list 'org-protocol-protocol-alist + '("capture-eww-readable" + :protocol "capture-eww-readable" + :function org-protocol-capture-html--capture-eww-readable + :kill-client t)) + + (defun org-protocol-capture-html--url-html (url) + "Return HTML from URL as string." + (let* ((response-buffer (url-retrieve-synchronously url nil t)) + (encoded-html (with-current-buffer response-buffer + (pop-to-buffer response-buffer) + ;; Skip HTTP headers, using marker provided by url-http + (delete-region (point-min) (1+ url-http-end-of-headers)) + (buffer-string)))) + (kill-buffer response-buffer) ; Not sure if necessary to avoid leaking buffer + (with-temp-buffer + ;; For some reason, running `decode-coding-region' in the + ;; response buffer has no effect, so we have to do it in a + ;; temp buffer. + (insert encoded-html) + (condition-case nil + ;; Fix undecoded text + (decode-coding-region (point-min) (point-max) 'utf-8) + (coding-system-error nil)) + (buffer-string)))) + + (defun org-protocol-capture-html--eww-readable (html) + "Return `eww-readable' part of HTML with title. +Returns list (HTML . TITLE)." + ;; Based on `eww-readable' + (let* ((html + ;; Convert " " in HTML to plain spaces. + ;; `libxml-parse-html-region' turns them into + ;; underlines. The closest I can find to an explanation + ;; is at . + (org-protocol-capture-html--nbsp-to-space html)) + (dom (with-temp-buffer + (insert html) + (libxml-parse-html-region (point-min) (point-max)))) + (title (caddr (car (dom-by-tag dom 'title))))) + (eww-score-readability dom) + (cons (with-temp-buffer + (shr-dom-print (eww-highest-readability dom)) + (buffer-string)) + title))))) + +;;;; Helper functions + +(defun org-protocol-capture-html--nbsp-to-space (s) + "Convert HTML non-breaking spaces to plain spaces in S." + ;; Not sure why sometimes these are in the HTML and Pandoc converts + ;; them to underlines instead of spaces, but this fixes it. + (replace-regexp-in-string (rx " ") " " s t t)) + +(defun org-protocol-capture-html--do-capture () + "Call `org-capture' and demote page headings in capture buffer." + (raise-frame) + (funcall 'org-capture nil template) + + ;; Demote page headings in capture buffer to below the + ;; top-level Org heading + (save-excursion + (goto-char (point-min)) + (re-search-forward (rx bol "*" (1+ space)) nil t) ; Skip 1st heading + (while (re-search-forward (rx bol "*" (1+ space)) nil t) + (dotimes (n org-protocol-capture-html-demote-times) + (org-demote-subtree))))) + +(provide 'org-protocol-capture-html) + +;;; org-protocol-capture-html ends here diff --git a/.emacs.d/src/keychain-environment.el b/.emacs.d/src/keychain-environment.el new file mode 100644 index 0000000..c448574 --- /dev/null +++ b/.emacs.d/src/keychain-environment.el @@ -0,0 +1,77 @@ +;;; keychain-environment.el --- load keychain environment variables -*- lexical-binding: t -*- + +;; Copyright (C) 2011-2018 Jonas Bernoulli +;; Copyright (C) 2008-2011 Paul Tipper + +;; Author: Paul Tipper +;; Maintainer: Jonas Bernoulli +;; Created: 20081218 +;; Homepage: https://github.com/tarsius/keychain-environment +;; Keywords: gnupg, pgp, ssh + +;; This file is not part of GNU Emacs. + +;; This file is free software; you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation; either version 3, or (at your option) +;; any later version. + +;; This file is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; For a full copy of the GNU General Public License +;; see . + +;;; Commentary: + +;; Keychain is a script that manages ssh-agent and gpg-agent. It is +;; typically run from the shell's initialization file. It allows your +;; shells and cron jobs to share a single ssh-agent and/or gpg-agent. + +;; When keychain is run, it checks for running agent, otherwise it +;; starts them. It saves the agents' environment variables to files +;; inside ~/.keychain/, so that subsequent shells can source these +;; files. + +;; When Emacs is started under X11 and not directly from a terminal +;; these variables are not set. This library looks for these files +;; created by keychain and then sets Emacs' environment variables +;; accordingly. It does not actually run keychain, so you still +;; have to run that from a login shell first. + +;; To use run the function `keychain-refresh-environment' in your +;; init file. If keychain has not been run yet when you start Emacs +;; you can also later call that function interactively. + +;; Also see: http://www.funtoo.org/wiki/Keychain + +;;; Code: + +;;;###autoload +(defun keychain-refresh-environment () + "Set ssh-agent and gpg-agent environment variables. + +Set the environment variables `SSH_AUTH_SOCK', `SSH_AGENT_PID' +and `GPG_AGENT' in Emacs' `process-environment' according to +information retrieved from files created by the keychain script." + (interactive) + (let* ((ssh (shell-command-to-string "keychain -q --noask --agents ssh --eval")) + (gpg (shell-command-to-string "keychain -q --noask --agents gpg --eval"))) + (list (and ssh + (string-match "SSH_AUTH_SOCK[=\s]\\([^\s;\n]*\\)" ssh) + (setenv "SSH_AUTH_SOCK" (match-string 1 ssh))) + (and ssh + (string-match "SSH_AGENT_PID[=\s]\\([0-9]*\\)?" ssh) + (setenv "SSH_AGENT_PID" (match-string 1 ssh))) + (and gpg + (string-match "GPG_AGENT_INFO[=\s]\\([^\s;\n]*\\)" gpg) + (setenv "GPG_AGENT_INFO" (match-string 1 gpg)))))) + +;;; _ +(provide 'keychain-environment) +;; Local Variables: +;; indent-tabs-mode: nil +;; End: +;;; keychain-environment.el ends here diff --git a/.emacs.d/src/reveal.js-3.8.0/.gitignore b/.emacs.d/src/reveal.js-3.8.0/.gitignore new file mode 100755 index 0000000..8eda50e --- /dev/null +++ b/.emacs.d/src/reveal.js-3.8.0/.gitignore @@ -0,0 +1,13 @@ +.idea/ +*.iml +*.iws +*.eml +out/ +.DS_Store +.svn +log/*.log +tmp/** +node_modules/ +.sass-cache +css/reveal.min.css +js/reveal.min.js diff --git a/.emacs.d/src/reveal.js-3.8.0/.travis.yml b/.emacs.d/src/reveal.js-3.8.0/.travis.yml new file mode 100755 index 0000000..e65e0df --- /dev/null +++ b/.emacs.d/src/reveal.js-3.8.0/.travis.yml @@ -0,0 +1,5 @@ +language: node_js +node_js: + - 11 +after_script: + - npm run build -- retire diff --git a/.emacs.d/src/reveal.js-3.8.0/CONTRIBUTING.md b/.emacs.d/src/reveal.js-3.8.0/CONTRIBUTING.md new file mode 100755 index 0000000..c2091e8 --- /dev/null +++ b/.emacs.d/src/reveal.js-3.8.0/CONTRIBUTING.md @@ -0,0 +1,23 @@ +## Contributing + +Please keep the [issue tracker](http://github.com/hakimel/reveal.js/issues) limited to **bug reports**, **feature requests** and **pull requests**. + + +### Personal Support +If you have personal support or setup questions the best place to ask those are [StackOverflow](http://stackoverflow.com/questions/tagged/reveal.js). + + +### Bug Reports +When reporting a bug make sure to include information about which browser and operating system you are on as well as the necessary steps to reproduce the issue. If possible please include a link to a sample presentation where the bug can be tested. + + +### Pull Requests +- Should follow the coding style of the file you work in, most importantly: + - Tabs to indent + - Single-quoted strings +- Should be made towards the **dev branch** +- Should be submitted from a feature/topic branch (not your master) + + +### Plugins +Please do not submit plugins as pull requests. They should be maintained in their own separate repository. More information here: https://github.com/hakimel/reveal.js/wiki/Plugin-Guidelines diff --git a/.emacs.d/src/reveal.js-3.8.0/LICENSE b/.emacs.d/src/reveal.js-3.8.0/LICENSE new file mode 100755 index 0000000..697d156 --- /dev/null +++ b/.emacs.d/src/reveal.js-3.8.0/LICENSE @@ -0,0 +1,19 @@ +Copyright (C) 2019 Hakim El Hattab, http://hakim.se, and reveal.js contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file diff --git a/.emacs.d/src/reveal.js-3.8.0/README.md b/.emacs.d/src/reveal.js-3.8.0/README.md new file mode 100755 index 0000000..e5a1911 --- /dev/null +++ b/.emacs.d/src/reveal.js-3.8.0/README.md @@ -0,0 +1,1388 @@ +# reveal.js [![Build Status](https://travis-ci.org/hakimel/reveal.js.svg?branch=master)](https://travis-ci.org/hakimel/reveal.js) Slides + +A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://revealjs.com/). + +reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [Markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). There's also a fully featured visual editor and platform for sharing reveal.js presentations at [slides.com](https://slides.com?ref=github). + + +## Table of contents + +- [Online Editor](#online-editor) +- [Installation](#installation) + - [Basic setup](#basic-setup) + - [Full setup](#full-setup) + - [Folder Structure](#folder-structure) +- [Instructions](#instructions) + - [Markup](#markup) + - [Markdown](#markdown) + - [Element Attributes](#element-attributes) + - [Slide Attributes](#slide-attributes) +- [Configuration](#configuration) +- [Presentation Size](#presentation-size) +- [Dependencies](#dependencies) +- [Ready Event](#ready-event) +- [Auto-sliding](#auto-sliding) +- [Keyboard Bindings](#keyboard-bindings) +- [Vertical Slide Navigation](#vertical-slide-navigation) +- [Touch Navigation](#touch-navigation) +- [Lazy Loading](#lazy-loading) +- [API](#api) + - [Slide Changed Event](#slide-changed-event) + - [Presentation State](#presentation-state) + - [Slide States](#slide-states) + - [Slide Backgrounds](#slide-backgrounds) + - [Parallax Background](#parallax-background) + - [Slide Transitions](#slide-transitions) + - [Internal links](#internal-links) + - [Fragments](#fragments) + - [Fragment events](#fragment-events) + - [Code syntax highlighting](#code-syntax-highlighting) + - [Slide number](#slide-number) + - [Overview mode](#overview-mode) + - [Fullscreen mode](#fullscreen-mode) + - [Embedded media](#embedded-media) + - [Stretching elements](#stretching-elements) + - [Resize Event](#resize-event) + - [postMessage API](#postmessage-api) +- [PDF Export](#pdf-export) +- [Theming](#theming) +- [Speaker Notes](#speaker-notes) + - [Share and Print Speaker Notes](#share-and-print-speaker-notes) + - [Server Side Speaker Notes](#server-side-speaker-notes) +- [Multiplexing](#multiplexing) + - [Master presentation](#master-presentation) + - [Client presentation](#client-presentation) + - [Socket.io server](#socketio-server) +- [MathJax](#mathjax) +- [License](#license) + +#### More reading + +- [Changelog](https://github.com/hakimel/reveal.js/releases): Up-to-date version history. +- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own! +- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks. +- [Plugins](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware): A list of plugins that can be used to extend reveal.js. + + +## Online Editor + +Presentations are written using HTML or Markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [https://slides.com](https://slides.com?ref=github). + + +## Installation + +The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source. + +### Basic setup + +The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser. + +1. Download the latest version of reveal.js from +2. Unzip and replace the example contents in index.html with your own +3. Open index.html in a browser to view it + +### Full setup + +Some reveal.js features, like external Markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code. + +1. Install [Node.js](http://nodejs.org/) (4.0.0 or later) + +1. Clone the reveal.js repository + ```sh + $ git clone https://github.com/hakimel/reveal.js.git + ``` + +1. Navigate to the reveal.js folder + ```sh + $ cd reveal.js + ``` + +1. Install dependencies + ```sh + $ npm install + ``` + +1. Serve the presentation and monitor source files for changes + ```sh + $ npm start + ``` + +1. Open to view your presentation + + You can change the port by using `npm start -- --port=8001`. + +### Folder Structure + +- **css/** Core styles without which the project does not function +- **js/** Like above but for JavaScript +- **plugin/** Components that have been developed as extensions to reveal.js +- **lib/** All other third party assets (JavaScript, CSS, fonts) + + +## Instructions + +### Markup + +Here's a barebones example of a fully working reveal.js presentation: +```html + + + + + + +
+
+
Slide 1
+
Slide 2
+
+
+ + + + +``` + +The presentation markup hierarchy needs to be `.reveal > .slides > section` where the `section` represents one slide and can be repeated indefinitely. If you place multiple `section` elements inside of another `section` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and will be included in the horizontal sequence. For example: + +```html +
+
+
Single Horizontal Slide
+
+
Vertical Slide 1
+
Vertical Slide 2
+
+
+
+``` + +### Markdown + +It's possible to write your slides using Markdown. To enable Markdown, add the `data-markdown` attribute to your `
` elements and wrap the contents in a ` +
+``` + +#### External Markdown + +You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file: the `data-separator` attribute defines a regular expression for horizontal slides (defaults to `^\r?\n---\r?\n$`, a newline-bounded horizontal rule) and `data-separator-vertical` defines vertical slides (disabled by default). The `data-separator-notes` attribute is a regular expression for specifying the beginning of the current slide's speaker notes (defaults to `notes?:`, so it will match both "note:" and "notes:"). The `data-charset` attribute is optional and specifies which charset to use when loading the external file. + +When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup). The following example customises all available options: + +```html +
+ +
+``` + +#### Element Attributes + +Special syntax (through HTML comments) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things. + +```html +
+ +
+``` + +#### Slide Attributes + +Special syntax (through HTML comments) is available for adding attributes to the slide `
` elements generated by your Markdown. + +```html +
+ +
+``` + +#### Configuring *marked* + +We use [marked](https://github.com/chjj/marked) to parse Markdown. To customise marked's rendering, you can pass in options when [configuring Reveal](#configuration): + +```javascript +Reveal.initialize({ + // Options which are passed into marked + // See https://marked.js.org/#/USING_ADVANCED.md#options + markdown: { + smartypants: true + } +}); +``` + +### Configuration + +At the end of your page you need to initialize reveal by running the following code. Note that all configuration values are optional and will default to the values specified below. + +```javascript +Reveal.initialize({ + + // Display presentation control arrows + controls: true, + + // Help the user learn the controls by providing hints, for example by + // bouncing the down arrow when they first encounter a vertical slide + controlsTutorial: true, + + // Determines where controls appear, "edges" or "bottom-right" + controlsLayout: 'bottom-right', + + // Visibility rule for backwards navigation arrows; "faded", "hidden" + // or "visible" + controlsBackArrows: 'faded', + + // Display a presentation progress bar + progress: true, + + // Display the page number of the current slide + slideNumber: false, + + // Add the current slide number to the URL hash so that reloading the + // page/copying the URL will return you to the same slide + hash: false, + + // Push each slide change to the browser history. Implies `hash: true` + history: false, + + // Enable keyboard shortcuts for navigation + keyboard: true, + + // Enable the slide overview mode + overview: true, + + // Vertical centering of slides + center: true, + + // Enables touch navigation on devices with touch input + touch: true, + + // Loop the presentation + loop: false, + + // Change the presentation direction to be RTL + rtl: false, + + // See https://github.com/hakimel/reveal.js/#navigation-mode + navigationMode: 'default', + + // Randomizes the order of slides each time the presentation loads + shuffle: false, + + // Turns fragments on and off globally + fragments: true, + + // Flags whether to include the current fragment in the URL, + // so that reloading brings you to the same fragment position + fragmentInURL: false, + + // Flags if the presentation is running in an embedded mode, + // i.e. contained within a limited portion of the screen + embedded: false, + + // Flags if we should show a help overlay when the questionmark + // key is pressed + help: true, + + // Flags if speaker notes should be visible to all viewers + showNotes: false, + + // Global override for autoplaying embedded media (video/audio/iframe) + // - null: Media will only autoplay if data-autoplay is present + // - true: All media will autoplay, regardless of individual setting + // - false: No media will autoplay, regardless of individual setting + autoPlayMedia: null, + + // Global override for preloading lazy-loaded iframes + // - null: Iframes with data-src AND data-preload will be loaded when within + // the viewDistance, iframes with only data-src will be loaded when visible + // - true: All iframes with data-src will be loaded when within the viewDistance + // - false: All iframes with data-src will be loaded only when visible + preloadIframes: null, + + // Number of milliseconds between automatically proceeding to the + // next slide, disabled when set to 0, this value can be overwritten + // by using a data-autoslide attribute on your slides + autoSlide: 0, + + // Stop auto-sliding after user input + autoSlideStoppable: true, + + // Use this method for navigation when auto-sliding + autoSlideMethod: Reveal.navigateNext, + + // Specify the average time in seconds that you think you will spend + // presenting each slide. This is used to show a pacing timer in the + // speaker view + defaultTiming: 120, + + // Enable slide navigation via mouse wheel + mouseWheel: false, + + // Hide cursor if inactive + hideInactiveCursor: true, + + // Time before the cursor is hidden (in ms) + hideCursorTime: 5000, + + // Hides the address bar on mobile devices + hideAddressBar: true, + + // Opens links in an iframe preview overlay + // Add `data-preview-link` and `data-preview-link="false"` to customise each link + // individually + previewLinks: false, + + // Transition style + transition: 'slide', // none/fade/slide/convex/concave/zoom + + // Transition speed + transitionSpeed: 'default', // default/fast/slow + + // Transition style for full page slide backgrounds + backgroundTransition: 'fade', // none/fade/slide/convex/concave/zoom + + // Number of slides away from the current that are visible + viewDistance: 3, + + // Parallax background image + parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'" + + // Parallax background size + parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" + + // Number of pixels to move the parallax background per slide + // - Calculated automatically unless specified + // - Set to 0 to disable movement along an axis + parallaxBackgroundHorizontal: null, + parallaxBackgroundVertical: null, + + // The display mode that will be used to show slides + display: 'block' + +}); +``` + +The configuration can be updated after initialization using the `configure` method: + +```javascript +// Turn autoSlide off +Reveal.configure({ autoSlide: 0 }); + +// Start auto-sliding every 5s +Reveal.configure({ autoSlide: 5000 }); +``` + +### Presentation Size + +All presentations have a normal size, that is, the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport. + +See below for a list of configuration options related to sizing, including default values: + +```javascript +Reveal.initialize({ + + // ... + + // The "normal" size of the presentation, aspect ratio will be preserved + // when the presentation is scaled to fit different resolutions. Can be + // specified using percentage units. + width: 960, + height: 700, + + // Factor of the display size that should remain empty around the content + margin: 0.1, + + // Bounds for smallest/largest possible scale to apply to content + minScale: 0.2, + maxScale: 1.5 + +}); +``` + +If you wish to disable this behavior and do your own scaling (e.g. using media queries), try these settings: + +```javascript +Reveal.initialize({ + + // ... + + width: "100%", + height: "100%", + margin: 0, + minScale: 1, + maxScale: 1 +}); +``` + +### Dependencies + +Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example: + +```javascript +Reveal.initialize({ + dependencies: [ + // Interpret Markdown in
elements + { src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, + { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, + + // Syntax highlight for elements + { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }, + + // Zoom in and out with Alt+click + { src: 'plugin/zoom-js/zoom.js', async: true }, + + // Speaker notes + { src: 'plugin/notes/notes.js', async: true }, + + // MathJax + { src: 'plugin/math/math.js', async: true } + ] +}); +``` + +You can add your own extensions using the same syntax. The following properties are available for each dependency object: +- **src**: Path to the script to load +- **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false +- **callback**: [optional] Function to execute when the script has loaded +- **condition**: [optional] Function which must return true for the script to be loaded + +### Ready Event + +A `ready` event is fired when reveal.js has loaded all non-async dependencies and is ready to start navigating. To check if reveal.js is already 'ready' you can call `Reveal.isReady()`. + +```javascript +Reveal.addEventListener( 'ready', function( event ) { + // event.currentSlide, event.indexh, event.indexv +} ); +``` + +Note that we also add a `.ready` class to the `.reveal` element so that you can hook into this with CSS. + +### Auto-sliding + +Presentations can be configured to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides: + +```javascript +// Slide every five seconds +Reveal.configure({ + autoSlide: 5000 +}); +``` + +When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »A« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying `autoSlideStoppable: false` in your reveal.js config. + +You can also override the slide duration for individual slides and fragments by using the `data-autoslide` attribute: + +```html +
+

After 2 seconds the first fragment will be shown.

+

After 10 seconds the next fragment will be shown.

+

Now, the fragment is displayed for 2 seconds before the next slide is shown.

+
+``` + +To override the method used for navigation when auto-sliding, you can specify the `autoSlideMethod` setting. To only navigate along the top layer and ignore vertical slides, set this to `Reveal.navigateRight`. + +Whenever the auto-slide mode is resumed or paused the `autoslideresumed` and `autoslidepaused` events are fired. + +### Keyboard Bindings + +If you're unhappy with any of the default keyboard bindings you can override them using the `keyboard` config option: + +```javascript +Reveal.configure({ + keyboard: { + 13: 'next', // go to the next slide when the ENTER key is pressed + 27: function() {}, // do something custom when ESC is pressed + 32: null // don't do anything when SPACE is pressed (i.e. disable a reveal.js default binding) + } +}); +``` + +### Vertical Slide Navigation + +Slides can be nested within other slides to create vertical stacks (see [Markup](#markup)). When presenting, you use the left/right arrows to step through the main (horizontal) slides. When you arrive at a vertical stack you can optionally press the up/down arrows to view the vertical slides or skip past them by pressing the right arrow. Here's an example showing a bird's-eye view of what this looks like in action: + + + +#### Navigation Mode +You can finetune the reveal.js navigation behavior by using the `navigationMode` config option. Note that these options are only useful for presnetations that use a mix of horizontal and vertical slides. The following navigation modes are available: + +| Value | Description | +| :--------------------------- | :---------- | +| default | Left/right arrow keys step between horizontal slides. Up/down arrow keys step between vertical slides. Space key steps through all slides (both horizontal and vertical). | +| linear | Removes the up/down arrows. Left/right arrows step through all slides (both horizontal and vertical). | +| grid | When this is enabled, stepping left/right from a vertical stack to an adjacent vertical stack will land you at the same vertical index.

Consider a deck with six slides ordered in two vertical stacks:
`1.1`    `2.1`
`1.2`    `2.2`
`1.3`    `2.3`

If you're on slide 1.3 and navigate right, you will normally move from 1.3 -> 2.1. With navigationMode set to "grid" the same navigation takes you from 1.3 -> 2.3. | + +### Touch Navigation + +You can swipe to navigate through a presentation on any touch-enabled device. Horizontal swipes change between horizontal slides, vertical swipes change between vertical slides. If you wish to disable this you can set the `touch` config option to false when initializing reveal.js. + +If there's some part of your content that needs to remain accessible to touch events you'll need to highlight this by adding a `data-prevent-swipe` attribute to the element. One common example where this is useful is elements that need to be scrolled. + +### Lazy Loading + +When working on presentation with a lot of media or iframe content it's important to load lazily. Lazy loading means that reveal.js will only load content for the few slides nearest to the current slide. The number of slides that are preloaded is determined by the `viewDistance` configuration option. + +To enable lazy loading all you need to do is change your `src` attributes to `data-src` as shown below. This is supported for image, video, audio and iframe elements. + +```html +
+ + + +
+``` + +#### Lazy Loading Iframes + +Note that lazy loaded iframes ignore the `viewDistance` configuration and will only load when their containing slide becomes visible. Iframes are also unloaded as soon as the slide is hidden. + +When we lazy load a video or audio element, reveal.js won't start playing that content until the slide becomes visible. However there is no way to control this for an iframe since that could contain any kind of content. That means if we loaded an iframe before the slide is visible on screen it could begin playing media and sound in the background. + +You can override this behavior with the `data-preload` attribute. The iframe below will be loaded +according to the `viewDistance`. + +```html +
+ +
+``` + +You can also change the default globally with the `preloadIframes` configuration option. If set to +`true` ALL iframes with a `data-src` attribute will be preloaded when within the `viewDistance` +regardless of individual `data-preload` attributes. If set to `false`, all iframes will only be +loaded when they become visible. + +### API + +The `Reveal` object exposes a JavaScript API for controlling navigation and reading state: + +```javascript +// Navigation +Reveal.slide( indexh, indexv, indexf ); +Reveal.left(); +Reveal.right(); +Reveal.up(); +Reveal.down(); +Reveal.prev(); +Reveal.next(); +Reveal.prevFragment(); +Reveal.nextFragment(); + +// Randomize the order of slides +Reveal.shuffle(); + +// Toggle presentation states, optionally pass true/false to force on/off +Reveal.toggleOverview(); +Reveal.togglePause(); +Reveal.toggleAutoSlide(); + +// Shows a help overlay with keyboard shortcuts, optionally pass true/false +// to force on/off +Reveal.toggleHelp(); + +// Change a config value at runtime +Reveal.configure({ controls: true }); + +// Returns the present configuration options +Reveal.getConfig(); + +// Fetch the current scale of the presentation +Reveal.getScale(); + +// Retrieves the previous and current slide elements +Reveal.getPreviousSlide(); +Reveal.getCurrentSlide(); + +Reveal.getIndices(); // { h: 0, v: 0, f: 0 } +Reveal.getSlidePastCount(); +Reveal.getProgress(); // (0 == first slide, 1 == last slide) +Reveal.getSlides(); // Array of all slides +Reveal.getTotalSlides(); // Total number of slides + +// Returns the speaker notes for the current slide +Reveal.getSlideNotes(); + +// State checks +Reveal.isFirstSlide(); +Reveal.isLastSlide(); +Reveal.isOverview(); +Reveal.isPaused(); +Reveal.isAutoSliding(); + +// Returns the top-level DOM element +getRevealElement(); //
...
+``` + +### Custom Key Bindings + +Custom key bindings can be added and removed using the following Javascript API. Custom key bindings will override the default keyboard bindings, but will in turn be overridden by the user defined bindings in the ``keyboard`` config option. + +```javascript +Reveal.addKeyBinding( binding, callback ); +Reveal.removeKeyBinding( keyCode ); +``` + +For example + +```javascript +// The binding parameter provides the following properties +// keyCode: the keycode for binding to the callback +// key: the key label to show in the help overlay +// description: the description of the action to show in the help overlay +Reveal.addKeyBinding( { keyCode: 84, key: 'T', description: 'Start timer' }, function() { + // start timer +} ) + +// The binding parameter can also be a direct keycode without providing the help description +Reveal.addKeyBinding( 82, function() { + // reset timer +} ) +``` + +This allows plugins to add key bindings directly to Reveal so they can + +* make use of Reveal's pre-processing logic for key handling (for example, ignoring key presses when paused); and +* be included in the help overlay (optional) + +### Slide Changed Event + +A `slidechanged` event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes. + +Some libraries, like MathJax (see [#226](https://github.com/hakimel/reveal.js/issues/226#issuecomment-10261609)), get confused by the transforms and display states of slides. Often times, this can be fixed by calling their update or render function from this callback. + +```javascript +Reveal.addEventListener( 'slidechanged', function( event ) { + // event.previousSlide, event.currentSlide, event.indexh, event.indexv +} ); +``` + +### Presentation State + +The presentation's current state can be fetched by using the `getState` method. A state object contains all of the information required to put the presentation back as it was when `getState` was first called. Sort of like a snapshot. It's a simple object that can easily be stringified and persisted or sent over the wire. + +```javascript +Reveal.slide( 1 ); +// we're on slide 1 + +var state = Reveal.getState(); + +Reveal.slide( 3 ); +// we're on slide 3 + +Reveal.setState( state ); +// we're back on slide 1 +``` + +### Slide States + +If you set `data-state="somestate"` on a slide `
`, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide. + +Furthermore you can also listen to these changes in state via JavaScript: + +```javascript +Reveal.addEventListener( 'somestate', function() { + // TODO: Sprinkle magic +}, false ); +``` + +### Slide Backgrounds + +Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page backgrounds outside of the slide area by adding a `data-background` attribute to your `
` elements. Four different types of backgrounds are supported: color, image, video and iframe. + +#### Color Backgrounds + +All CSS color formats are supported, including hex values, keywords, `rgba()` or `hsl()`. + +```html +
+

Color

+
+``` + +#### Image Backgrounds + +By default, background images are resized to cover the full page. Available options: + +| Attribute | Default | Description | +| :------------------------------- | :--------- | :---------- | +| data-background-image | | URL of the image to show. GIFs restart when the slide opens. | +| data-background-size | cover | See [background-size](https://developer.mozilla.org/docs/Web/CSS/background-size) on MDN. | +| data-background-position | center | See [background-position](https://developer.mozilla.org/docs/Web/CSS/background-position) on MDN. | +| data-background-repeat | no-repeat | See [background-repeat](https://developer.mozilla.org/docs/Web/CSS/background-repeat) on MDN. | +| data-background-opacity | 1 | Opacity of the background image on a 0-1 scale. 0 is transparent and 1 is fully opaque. | + +```html +
+

Image

+
+
+

This background image will be sized to 100px and repeated

+
+``` + +#### Video Backgrounds + +Automatically plays a full size video behind the slide. + +| Attribute | Default | Description | +| :--------------------------- | :------ | :---------- | +| data-background-video | | A single video source, or a comma separated list of video sources. | +| data-background-video-loop | false | Flags if the video should play repeatedly. | +| data-background-video-muted | false | Flags if the audio should be muted. | +| data-background-size | cover | Use `cover` for full screen and some cropping or `contain` for letterboxing. | +| data-background-opacity | 1 | Opacity of the background video on a 0-1 scale. 0 is transparent and 1 is fully opaque. | + +```html +
+

Video

+
+``` + +#### Iframe Backgrounds + +Embeds a web page as a slide background that covers 100% of the reveal.js width and height. The iframe is in the background layer, behind your slides, and as such it's not possible to interact with it by default. To make your background interactive, you can add the `data-background-interactive` attribute. + +```html +
+

Iframe

+
+``` + +#### Background Transitions + +Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing `backgroundTransition: 'slide'` to the `Reveal.initialize()` call. Alternatively you can set `data-background-transition` on any section with a background to override that specific transition. + + +### Parallax Background + +If you want to use a parallax scrolling background, set the first two properties below when initializing reveal.js (the other two are optional). + +```javascript +Reveal.initialize({ + + // Parallax background image + parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg" + + // Parallax background size + parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto) + + // Number of pixels to move the parallax background per slide + // - Calculated automatically unless specified + // - Set to 0 to disable movement along an axis + parallaxBackgroundHorizontal: 200, + parallaxBackgroundVertical: 50 + +}); +``` + +Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://revealjs.com/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg¶llaxBackgroundSize=2100px%20900px). + +### Slide Transitions + +The global presentation transition is set using the `transition` config value. You can override the global transition for a specific slide by using the `data-transition` attribute: + +```html +
+

This slide will override the presentation transition and zoom!

+
+ +
+

Choose from three transition speeds: default, fast or slow!

+
+``` + +You can also use different in and out transitions for the same slide: + +```html +
+ The train goes on … +
+
+ and on … +
+
+ and stops. +
+
+ (Passengers entering and leaving) +
+
+ And it starts again. +
+``` +You can choose from `none`, `fade`, `slide`, `convex`, `concave` and `zoom`. +### Internal links + +It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (`
`): + +```html +Link +Link +``` + +You can also add relative navigation links, similar to the built in reveal.js controls, by appending one of the following classes on any element. Note that each element is automatically given an `enabled` class when it's a valid navigation route based on the current slide. + +```html + + + + + + +``` + +### Fragments + +Fragments are used to highlight individual elements on a slide. Every element with the class `fragment` will be stepped through before moving on to the next slide. Here's an example: http://revealjs.com/#/fragments + +The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment: + +```html +
+

grow

+

shrink

+

fade-out

+

fade-up (also down, left and right!)

+

fades in, then out when we move to the next step

+

fades in, then obfuscate when we move to the next step

+

blue only once

+

highlight-red

+

highlight-green

+

highlight-blue

+
+``` + +Multiple fragments can be applied to the same element sequentially by wrapping it, this will fade in the text on the first step and fade it back out on the second. + +```html +
+ + I'll fade in, then out + +
+``` + +The display order of fragments can be controlled using the `data-fragment-index` attribute. + +```html +
+

Appears last

+

Appears first

+

Appears second

+
+``` + +### Fragment events + +When a slide fragment is either shown or hidden reveal.js will dispatch an event. + +Some libraries, like MathJax (see #505), get confused by the initially hidden fragment elements. Often times this can be fixed by calling their update or render function from this callback. + +```javascript +Reveal.addEventListener( 'fragmentshown', function( event ) { + // event.fragment = the fragment DOM element +} ); +Reveal.addEventListener( 'fragmenthidden', function( event ) { + // event.fragment = the fragment DOM element +} ); +``` + +### Code syntax highlighting + +By default, Reveal is configured with [highlight.js](https://highlightjs.org/) for code syntax highlighting. To enable syntax highlighting, you'll have to load the highlight plugin ([plugin/highlight/highlight.js](plugin/highlight/highlight.js)) and a highlight.js CSS theme (Reveal comes packaged with the Monokai themes: [lib/css/monokai.css](lib/css/monokai.css)). + +```javascript +Reveal.initialize({ + // More info https://github.com/hakimel/reveal.js#dependencies + dependencies: [ + { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }, + ] +}); +``` + +Below is an example with clojure code that will be syntax highlighted. When the `data-trim` attribute is present, surrounding whitespace is automatically removed. HTML will be escaped by default. To avoid this, for example if you are using `` to call out a line of code, add the `data-noescape` attribute to the `` element. + +```html +
+ 

+(def lazy-fib
+  (concat
+   [0 1]
+   ((fn rfib [a b]
+        (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))
+
+
+``` + +### Slide number + +If you would like to display the page number of the current slide you can do so using the `slideNumber` and `showSlideNumber` configuration values. + +```javascript +// Shows the slide number using default formatting +Reveal.configure({ slideNumber: true }); + +// Slide number formatting can be configured using these variables: +// "h.v": horizontal . vertical slide number (default) +// "h/v": horizontal / vertical slide number +// "c": flattened slide number +// "c/t": flattened slide number / total slides +Reveal.configure({ slideNumber: 'c/t' }); + +// You can provide a function to fully customize the number: +Reveal.configure({ slideNumber: function() { + // Ignore numbering of vertical slides + return [ Reveal.getIndices().h ]; +}}); + +// Control which views the slide number displays on using the "showSlideNumber" value: +// "all": show on all views (default) +// "speaker": only show slide numbers on speaker notes view +// "print": only show slide numbers when printing to PDF +Reveal.configure({ showSlideNumber: 'speaker' }); +``` + +### Overview mode + +Press »ESC« or »O« keys to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides, +as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks: + +```javascript +Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } ); +Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } ); + +// Toggle the overview mode programmatically +Reveal.toggleOverview(); +``` + +### Fullscreen mode + +Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode. + +### Embedded media + +Add `data-autoplay` to your media element if you want it to automatically start playing when the slide is shown: + +```html + +``` + +If you want to enable or disable autoplay globally, for all embedded media, you can use the `autoPlayMedia` configuration option. If you set this to `true` ALL media will autoplay regardless of individual `data-autoplay` attributes. If you initialize with `autoPlayMedia: false` NO media will autoplay. + +Note that embedded HTML5 `