GitXplorerGitXplorer
d

linkmarks

public
49 stars
6 forks
1 issues

Commits

List of commits on branch master.
Unverified
04f4b372e140e94562087614fa7807421558ba81

docs: add missing ) in the readme

FFuco1 committed 9 months ago
Verified
9ca42f4d1e4b2bc8a63aa346147d6813ca5cf524

Remove Helm as a dependency

ddustinlacewell committed a year ago
Unverified
914bcb9172c5a9c7cab88de31e359de595e85021

Bookmark label, use configured bookmark file, fix entry template use

committed 5 years ago
Unverified
481a833d2eaeff54569b3c779818342bdc6a1f78

Update capture template syntax

ddustinlacewell committed 6 years ago
Unverified
59cc77838ef671690ed9f277bf642d9333f029ec

Change the cl import to cl-lib

ddustinlacewell committed 6 years ago
Unverified
971154d45e1e785607ced5024610cb8376ff8ca2

Add missing import

ddustinlacewell committed 6 years ago

README

The README file for this repository.
  • Linkmarks.el

Linkmarks.el leverages org-mode for bookmarks so you can:

  • Keep your bookmarks in org-mode
  • Organize them any way you want
  • Use any supported link type as a bookmark!
  • Use org-capture for new bookmarks.
  • Easily edit bookmarks by hand
  • Export to the web!
  • Installation

** el-get #+begin_src emacs-lisp (el-get-bundle linkmarks :url "https://github.com/dustinlacewell/linkmarks.git" :features linkmarks) #+end_src

** straight.el #+begin_src emacs-lisp (use-package linkmarks :straight (linkmarks :type git :host github :repo "dustinlacewell/linkmarks")) #+end_src

  • Configuration

The only setting you need to configure is =linkmarks-file=:

#+begin_src emacs-lisp (setq linkmarks-file "~/org/bookmarks.org") #+end_src

  • Usage

** linkmarks-capture

To create a new bookmark, execute =M-x linkmarks-capture= or bind it to key of your choice. It will ask for a title, and then allow you to enter in the link data. The default template looks like this:

#+begin_src text

  • Bookmark Title [[link content goes here]] added: [2018-08-30 Thu 03:53] #+end_src

Use =C-c C-w= to refile into your bookmarks!

** linkmarks-select

To select and visit a bookmark, execute =M-x linkmarks-select= or bind it to a key. It will prompt you with =completing-read= and visit your selection.

  • Bookmark File

Your bookmark file is just a normal org-mode file. The way a bookmark is defined is simple enough: Any header followed by a link on the next line is a bookmark.

You can nest bookmarks, you can have headings that are purely organizational, you can have additional notes or anything else. The only thing that matters are headings followed by an org-mode link.

  • Examples

** Files

As usual, files can be linked to by simply specifying their path:

#+begin_src text

  • My Emacs Config [[~/.emacs.d/init.el]] #+end_src

*** Search within a file

#+begin_src text

  • First TODO [[~/org/todo.org::TODO]] #+end_src

*** Some heading in an org file

#+begin_src text

  • Foo Project [[~/org/projects.org::*Foo]] #+end_src

** Directories

This is quite useful:

#+begin_src text ,* XDG config home [[elisp:(helm-find-files-1 "~/.config/")]] #+end_src

** Elisp

You can have bookmarks that run arbitrary elisp!

#+begin_src text

  • Start Playlist [[elisp:(start-playlist (completing-read "playlist" '("rock" "hiphop" "bluegrass")))]] #+end_src

** Others

There are many stock link types you can [[https://orgmode.org/manual/External-links.html][check out]].

You can even [[https://orgmode.org/manual/Adding-hyperlink-types.html][make your own]]!