README.md

   1 # org-searching.el
   2 Searching Org-mode with search engines.
   3
   4 # Install #
   5
   6 - You can install this package through MELPA.
   7
   8 # Config #
   9
  10 ## use-package ##
  11
  12 ``` emacs-lisp
  13 (use-package org-searching
  14   :ensure t
  15   :commands (org-searching-string org-searching-regexp org-searching-headlines)
  16   )
  17 ```
  18
  19 # Usage #
  20
  21 ## Use Cases ##
  22
  23 If you organize your knowledge wiki with Org-mode, and store them in a
  24 directory, you may want to search like this:
  25
  26 - search through all Org files for a specific thing with `[M-x org-searching-string]`.
  27 - search all Org files under current path by specify `[C-u]`.
  28 - search with regular expression with `[M-x org-searching-regexp]`.
  29 - search only org-mode headlines for quick search (because most user define a
  30   short description with headline) with `[M-x org-searching-headlines]`.
  31