README.md

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