Add README
This commit is contained in:
parent
6f6f0b906f
commit
c4d73622cd
1 changed files with 69 additions and 0 deletions
69
README.org
Normal file
69
README.org
Normal file
|
@ -0,0 +1,69 @@
|
|||
#+title: elfeed-export
|
||||
#+author: Bram Schoenmakers
|
||||
#+export_file_name: elfeed-export.info
|
||||
#+property: header-args:elisp :results none :exports code
|
||||
|
||||
* Introduction
|
||||
|
||||
/elfeed-export/ exports your feed entries from the [[https://github.com/skeeto/elfeed][elfeed RSS reader for Emacs]].
|
||||
|
||||
The following export formats are currently supported:
|
||||
|
||||
- JSON with the ~elfeed-export-to-json-file~ command.
|
||||
- Emacs Lisp Data (*.eld) with the ~elfeed-export-to-lisp-file~ command.
|
||||
|
||||
* Installation
|
||||
|
||||
/elfeed-export/ is not on MELPA, therefore clone the directory first:
|
||||
|
||||
: git clone https://codeberg.org/bram85/elfeed-export.git
|
||||
|
||||
Then configure the package as follows:
|
||||
|
||||
#+begin_src elisp
|
||||
(use-package elfeed-export
|
||||
:ensure nil
|
||||
:load-path "/path/to/elfeed-export")
|
||||
#+end_src
|
||||
|
||||
* Configuration
|
||||
|
||||
The following table shows the customizable settings for /elfeed-export/:
|
||||
|
||||
#+begin_src emacs-lisp :exports results :results table :colnames '("Custom variable" "Description")
|
||||
(let ((rows))
|
||||
(mapatoms
|
||||
(lambda (symbol)
|
||||
(when (and (string-match "\\_<elfeed-export"
|
||||
(symbol-name symbol))
|
||||
(custom-variable-p symbol))
|
||||
(push `(,symbol
|
||||
,(car
|
||||
(split-string
|
||||
(or (get (indirect-variable symbol)
|
||||
'variable-documentation)
|
||||
(get symbol 'variable-documentation)
|
||||
"")
|
||||
"\n")))
|
||||
rows))))
|
||||
(sort rows (lambda (item1 item2)
|
||||
(string< (car item1) (car item2)))))
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
| Custom variable | Description |
|
||||
|----------------------------+----------------------------------------------------------------------|
|
||||
| elfeed-export-exclude-tags | Do not export entries that have any of these tags. |
|
||||
| elfeed-export-fields | Which fields to export per entry and a function to obtain the value. |
|
||||
| elfeed-export-include-tags | Export entries that have any of these tags. |
|
||||
| elfeed-export-predicates | Entries that match all of these predicates are exported. |
|
||||
|
||||
** COMMENT Attribution :noexport:
|
||||
|
||||
The code to generate the table of configuration items was inspired by an idea of [[https://xenodium.com/generating-elisp-org-docs/][Álvaro Ramírez]] (a.k.a. xenodium).
|
||||
|
||||
* Meta :noexport:
|
||||
|
||||
Local variables:
|
||||
eval: (add-hook 'after-save-hook #'org-texinfo-export-to-info 0 t)
|
||||
End:
|
Loading…
Reference in a new issue