Commit graph

78 commits

Author SHA1 Message Date
Jethro Kuan
1f02b0c5dd
(docs): update org-protocol installation for MacOS (#225) 2020-03-05 11:51:28 +08:00
Jethro Kuan
b7a7741bb0
(feature): use org-capture templates (#216)
Instead of implementing our own templating system, we abuse org-capture's templating system. We add 2 additional properties:

- :head: a starting template that goes at the beginning of the file.
- :file-name: a string that expands to the file name

The templates are customizable at `org-roam-capture-templates` and `org-roam-ref-capture-templates`.
2020-03-05 00:21:24 +08:00
Tyler
4c3d5b90a7 (docs): add Doom Emacs installation instructions (#212) 2020-03-01 23:56:05 +08:00
Jethro Kuan
150ae65564
(feature): deprecate roam-protocol, extend org-protocol instead (#203)
Add 2 custom handlers:

1. roam-file?file=path: this simply opens the file at path in Emacs.
2. roam-ref?ref=ref&template=roam-template&title=title&...: attempts to open a roam note with a given ROAM_KEY. If the note doesn't exist, create one. Else, open it.
2020-02-29 22:09:04 +08:00
Jethro Kuan
0c2aaad3df
(feature): use sqlite as backing database (#200)
All org-roam related information will now be stored in the database. Henceforth, the cache needs to be built synchronously once (via `M-x org-roam-build-cache`), which is then incrementally updated.
2020-02-29 15:56:08 +08:00
Jethro Kuan
962ef23cce
(fix): Require a minimum version of Org 9.2 for roam link styling (#190) 2020-02-26 16:29:20 +08:00
Jethro Kuan
5e76c67cf6
(feature): emacs-lisp handling for roam:// links (#188)
We emulate org-protocol, and advise server-find-files, stripping the
roam protocol from the filename. This reduces the setup required to
open `roam://` links.
2020-02-26 15:35:20 +08:00
Herbert Jones
b382b1f21a
(docs): add documentation for multiple org-roam directories (#187) 2020-02-26 15:23:29 +08:00
Jethro Kuan
f1fb9f4680
(docs): remove :after from package install (#186)
Some of org-roam's functions (e.g. org-roam-today and
org-roam-find-file) should not need to have org loaded before use.
2020-02-26 11:00:24 +08:00
Jethro Kuan
5b96cf806f
(docs): Add documentation for #+ROAM_ALIAS attribute (#185) 2020-02-26 01:33:49 +08:00
leaen
5f6ff4282c
(docs): fix broken markdown src block (#176) 2020-02-24 17:08:29 +08:00
wrycode
a0559a2709
(docs): add note about removing title timestamps in configuration.md (#175) 2020-02-24 14:55:07 +08:00
wrycode
de1ac9d5cc
Fix typo in tour.md (#172) 2020-02-24 10:28:16 +08:00
Jethro Kuan
c54c206694
(feature) add templating functionality via org-roam-template (#165)
This allows users to customize the filename, and the content of the template.
2020-02-23 17:11:49 +08:00
Jethro Kuan
cba79b941a
(feature): add custom font styling for org-roam links (#162)
* (feature): add custom font styling for org-roam links

This adds 'org-roam-link-face. When org-roam-mode is on, all roam
links take this face. By default, it is exactly the same as 'org-link,
and would require styling.

* update docs
2020-02-22 21:11:14 +08:00
Jethro Kuan
fe3f0e3b6c (docs): documentation on how to enable Chrome external app checkbox on Linux (#157)
* Enable Chrome external app checkbox on Linux

* Fix command to write file
2020-02-22 11:12:33 +08:00
Jethro Kuan
571f65cebd
(docs): Add graph setup documentation for MacOS (#146)
Thanks @naistran for instructions, and @leothelocust and @seandavi for
discussion and confirmation
2020-02-21 13:17:09 +08:00
Jethro Kuan
8523fb43b4
(feature): global org-roam-mode (#143)
Makes org-roam-mode a global minor mode. This mode adds an advice to find-file-function, which decides whether to turn on the local post-command-hook and after-save-hook.

It also advices delete-file and rename-file to ensure cache consistency. Also fixes a bug introduced with #142
2020-02-20 17:33:30 +08:00
Jethro Kuan
ddaf855b5d
(chore): some cleanups (#139)
* move org-roam-switch-to-buffer

* add org-roam-switch-to-buffer to docs

* Update changelog
2020-02-20 13:38:31 +08:00
Hendrik Cech
05ada41710
(docs): add Spacemacs installation instructions (#133) 2020-02-20 08:48:47 +08:00
Jethro Kuan
ce305af319
(breaking): change org-roam-file-format to a function (#103)
This allows for more flexible naming of files. Now filename defaults
to yyyymmddhhmmss_title_here.org. Also, remove
`org-use-timestamp-as-filename`, and change it to
`org-roam-filename-noconfirm` to better describe what it is doing.s
2020-02-17 13:50:40 +08:00
chip2n
159b64b538
(feature): add support for file encryption by default (#90)
This is controlled by variable org-roam-encrypt-files
2020-02-16 18:31:51 +08:00
Jethro Kuan
8ec3b441d1
(docs): document deft-title patching (#89) 2020-02-16 14:29:58 +08:00
Jethro Kuan
914bbe3b53
(docs): overhaul documentation (#76)
Updated for latest Org-roam, and add all relevant information into the new documentation site.
2020-02-15 14:49:11 +08:00
Jethro Kuan
efd2072070
Add documentation for configuration options (#65)
* document org-roam-directory

* rename org-roam-position, and document org-roam-buffer-position

* document org-roam-buffer

* document org-roam-buffer-width

* Document org-roam-graphviz-executable

* document org-roam-graph-viewer

* document org-roam-link-title-format
2020-02-13 03:14:34 +08:00
Jethro Kuan
791c059200
Simplify org-roam-insert and org-roam-find-file (#62)
* Simplify org-roam-insert and org-roam-find-file

See #59.

* Add docs for org-roam automatic filenaming

* Update installation instructions
2020-02-13 00:25:45 +08:00
Jethro Kuan
c278ac4350 add readthedocs.yml 2020-02-12 19:40:13 +08:00
Jethro Kuan
2aca311cad Add documentation 2020-02-12 19:05:19 +08:00