https://github.com/emacs-helm/helm-navi

Navigate headings and keywords provided by navi-mode and outshine using Helm
https://github.com/emacs-helm/helm-navi

emacs helm navi-mode outorg outshine

Last synced: 3 months ago
JSON representation

Navigate headings and keywords provided by navi-mode and outshine using Helm

• Host: GitHub
• URL: https://github.com/emacs-helm/helm-navi
• Owner: emacs-helm
• License: gpl-3.0
• Created: 2017-03-27T08:22:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-17T11:43:14.000Z (over 1 year ago)
• Last Synced: 2024-05-01T11:38:44.277Z (7 months ago)
• Topics: emacs, helm, navi-mode, outorg, outshine
• Language: Emacs Lisp
• Homepage:
• Size: 109 KB
• Stars: 12
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
* helm-navi

[[https://melpa.org/#/helm-navi][file:https://melpa.org/packages/helm-navi-badge.svg]]

This package lets you navigate through a buffer using the headings and keywords provided by [[https://github.com/tj64/navi][navi-mode]] and [[https://github.com/tj64/outshine][outshine]], presented in a Helm buffer.  Here's an example (note that fontification will be shown according to your own theme and faces):

[[screenshot.png]]

** Installation

Install the package from MELPA and you're all set!

If you want to install it manually, put =helm-navi.el= in your =load-path=, then add this to your init file:

#+BEGIN_SRC elisp

  (require 'helm-navi)

#+END_SRC

** Commands

+  =helm-navi=: Show all =navi-mode= keywords and =outshine= headings in a Helm buffer.  This is the equivalent of running =outshine-navi= and then pressing =C-8 a=.

+  =helm-navi-headings=: Show all =outshine= headings in Helm buffer.

** Tips

If you use =use-package= to organize your init file, you may want to add this to your config, which makes it very easy to quickly navigate to individual package configuration with =helm-navi=:

#+BEGIN_SRC elisp

  (use-package navi-mode

    :config

    ;; Add "use-package" lines to `navi-keywords'.

    (setf (cdr (assoc :ALL (cdr (assoc "emacs-lisp" navi-keywords))))

          "^[[:space:]]*(\\(use-package\\|\\(cl-\\)\\{0,1\\}def[a-z]+\\)\\*? "))

#+END_SRC

** Contributions

Yes, please.

** Credits

+  Thanks to [[https://github.com/thierryvolpiatto][Thierry Volpiatto]] for his tireless work on Helm.

+  Thanks to [[https://github.com/tj64][Thorsten Jolitz]] for =outshine= / =outorg= / =navi-mode=.

+  Thanks to [[https://github.com/syohex][Syohei YOSHIDA]] and [[https://github.com/purcell][Steve Purcell]] for their tireless work curating MELPA.

** See Also

+ [[https://ekaschalk.github.io/post/outline-ivy/][outline-ivy]]: A package that provides similar functionality for Ivy.

** License

GPLv3