[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/kiwix c0c597d 14/18: Improve package config examples on
From: |
Stefan Monnier |
Subject: |
[elpa] externals/kiwix c0c597d 14/18: Improve package config examples on README |
Date: |
Wed, 4 Aug 2021 18:28:11 -0400 (EDT) |
branch: externals/kiwix
commit c0c597d1e1653112f3e10c67dcc22d85beb2aed8
Author: stardiviner <numbchild@gmail.com>
Commit: stardiviner <numbchild@gmail.com>
Improve package config examples on README
---
README.org | 43 ++++++++++++++++++++++++++++++++++++++++---
1 file changed, 40 insertions(+), 3 deletions(-)
diff --git a/README.org b/README.org
index 360b37f..f446032 100644
--- a/README.org
+++ b/README.org
@@ -305,15 +305,52 @@ docker container ls --all | grep "kiwix-serve" | cat
** use-package
+*** for local kiwix-serve server
+
#+begin_src emacs-lisp
(use-package kiwix
:ensure t
:after org
- :custom ((kiwix-server-use-docker t)
+ :commands (kiwix-launch-server kiwix-at-point)
+ :bind (:map document-prefix ("w" . kiwix-at-point))
+ :custom ((kiwix-server-type 'kiwix-serve-local)
+ (kiwix-server-url "http://127.0.0.1")
(kiwix-server-port 8089)
- (kiwix-default-library "wikipedia_en_all_2016-02.zim") ;
"wikipedia_zh_all_2015-11.zim"
- (kiwix-default-browser-function 'eww))
+ (kiwix-zim-dir (expand-file-name "/path/to/kiwix_zim_libraries")))
+ :hook (org-load . org-kiwix-setup-link)
+ :init (require 'org-kiwix)
+ :config (add-hook 'org-load-hook #'org-kiwix-setup-link))
+#+end_src
+
+*** for local Docker server
+
+#+begin_src emacs-lisp
+(use-package kiwix
+ :ensure t
+ :after org
+ :commands (kiwix-launch-server kiwix-at-point)
+ :bind (:map document-prefix ("w" . kiwix-at-point))
+ :custom ((kiwix-server-type 'docker-local)
+ (kiwix-server-url "http://127.0.0.1")
+ (kiwix-server-port 8089)
+ (kiwix-zim-dir (expand-file-name "/path/to/kiwix_zim_libraries")))
+ :hook (org-load . org-kiwix-setup-link)
+ :init (require 'org-kiwix)
+ :config (add-hook 'org-load-hook #'org-kiwix-setup-link))
+#+end_src
+
+*** for remote Docker server
+
+#+begin_src emacs-lisp
+(use-package kiwix
+ :ensure t
+ :after org
:commands (kiwix-launch-server kiwix-at-point)
+ :bind (:map document-prefix ("w" . kiwix-at-point))
+ :custom ((kiwix-server-type 'docker-remote)
+ (kiwix-server-url "http://192.168.31.251")
+ (kiwix-server-port 8089))
+ :hook (org-load . org-kiwix-setup-link)
:init (require 'org-kiwix)
:config (add-hook 'org-load-hook #'org-kiwix-setup-link))
#+end_src
- [elpa] externals/kiwix 12e13c8 02/18: support remote Docker service, (continued)
- [elpa] externals/kiwix 12e13c8 02/18: support remote Docker service, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix 423f607 05/18: Concentrate all kiwix library dir variables into only one, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix 716f3c4 12/18: Add condition to detect kiwix library path exist to fix GitHub Actions, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix e191c31 09/18: improve function kiwix-get-libraries to support remote Docker server, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix 0ec84f3 03/18: use dynamic ZIM library path, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix 3330d7e 08/18: Add extra library "elquery" for parsing HTTP query HTML result, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix a33c4a2 16/18: Fix kiwix-libraries variable not initialized by function kiwix-get-libraries, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix 0f85022 17/18: Add autoload cookies and improve docstring, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix f49557d 11/18: Fix format three fields, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix f9cae99 13/18: Improve kiwix-server-type docstring, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix c0c597d 14/18: Improve package config examples on README,
Stefan Monnier <=
- [elpa] externals/kiwix 9521d3b 15/18: Change default kiwix-server-type to docker-local, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix 71e770c 18/18: Update config example in source code document section, Stefan Monnier, 2021/08/04
- [elpa] externals/kiwix d1e8fa2 10/18: Fix void variable kiwix-zim-dir, Stefan Monnier, 2021/08/04