ol-elpher

Org-link support for Elpher
git clone https://git.jamzattack.xyz/ol-elpher
Log | Files | Refs | LICENSE

README.org (1299B)


      1 #+title: ol-elpher
      2 #+author: Jamie Beardslee
      3 #+email: jdb@jamzattack.xyz
      4 
      5 This package provides org link support for Elpher.
      6 
      7 * Installation
      8 ** package.el
      9 
     10 Download ol-elpher.el, and use =M-x package-install-file RET
     11 path/to/ol-elpher.el=.
     12 
     13 ** straight.el
     14 
     15 Evaluate the following:
     16 
     17 #+begin_src emacs-lisp
     18   (straight-use-package
     19    '(ol-elpher :type git
     20 	       :flavor melpa
     21 	       :repo "git://jamzattack.xyz/ol-elpher"))
     22 #+end_src
     23 
     24 ** Manual installation
     25 
     26 1. Download ol-elpher.el
     27 2. Stick it in [[help:load-path][load-path]]
     28 3. Update autoloads
     29 4. (optionally) byte-compile it
     30 
     31 * Using ol-elpher
     32 
     33 ** Loading
     34 
     35 To use this package, you need to either add it to [[help:org-modules][org-modules]], or
     36 [[help:require][require]] it manually.  This should work fine:
     37 
     38 #+begin_src emacs-lisp
     39   (add-to-list 'org-modules 'ol-elpher)
     40 #+end_src
     41 
     42 ** Storing links
     43 
     44 Once this library is loaded, you can use [[help:org-store-link][org-store-link]] from the
     45 elpher buffer to create an org link to the visited page.  This link
     46 can then be recalled in an org-mode buffer Using [[help:org-insert-link][org-insert-link]]
     47 (normally =C-c C-l=) or [[help:org-insert-last-stored-link][org-insert-last-stored-link]].
     48 
     49 See [[info:org#Handling Links][this section]] in the org manual for more details.
     50 
     51 * License
     52 
     53 GPL3+