From 1433dbc31602c412914c71ecc81aa5dcf6b03daf Mon Sep 17 00:00:00 2001 From: Jethro Kuan Date: Mon, 23 Mar 2020 15:34:21 +0800 Subject: [PATCH] (release): v1.0.0 (#341) --- CHANGELOG.md | 9 +++-- README.md | 17 ++++++--- doc/installation.md | 85 +++++++++++++-------------------------------- org-roam.el | 6 ++-- 4 files changed, 46 insertions(+), 71 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f7799b0..8087ed5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,17 +1,21 @@ # Changelog -## 1.0.0 (TBD) +## 1.0.0 (23-03-2020) + +Org-roam is now on MELPA! We have squashed most of the bugs, and Org-roam has +been stable for the most part. ## New Features * [#269][gh-269] Add `org-roam-graphviz-extra-options` * [#257][gh-257] Add a company-backend `company-org-roam` -* [#284][gh-284], [#289][gh-289] Configurable `org-roam-completion-system` with options `'default`, `'ido`, `'ivy` and `'helm`. +* [#284][gh-284], [#289][gh-289] Configurable `org-roam-completion-system` with options `'default`, `'ido`, `'ivy` and `'helm` * [#289][gh-289] Add customizable `org-roam-fuzzy-match` to allow fuzzy-matching of candidates * [#290][gh-290] Add `org-roam-date-title-format` and `org-roam-date-filename-format` for customizing Org-roam's date files * [#296][gh-296] Allow multiple exclusion matchers in `org-roam-graph-exclude-matcher` ## Bugfixes * [#293][gh-293] Fix capture templates not working as expected for `org-roam-find-file` +* [#275][gh-275] Fix database rebuild when `org-roam-directory` is set locally ## 1.0.0-rc1 (06-03-2020) @@ -138,6 +142,7 @@ Mostly a documentation/cleanup release. [gh-257]: https://github.com/jethrokuan/org-roam/pull/257 [gh-259]: https://github.com/jethrokuan/org-roam/pull/259 [gh-269]: https://github.com/jethrokuan/org-roam/pull/269 +[gh-275]: https://github.com/jethrokuan/org-roam/pull/275 [gh-284]: https://github.com/jethrokuan/org-roam/pull/284 [gh-289]: https://github.com/jethrokuan/org-roam/pull/289 [gh-290]: https://github.com/jethrokuan/org-roam/pull/290 diff --git a/README.md b/README.md index e9fbfdc..cf79a24 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![License GPL 3][badge-license]](http://www.gnu.org/licenses/gpl-3.0.txt) [![Documentation Status](https://readthedocs.org/projects/org-roam/badge/?version=latest)](https://org-roam.readthedocs.io/en/latest/?badge=latest) [![GitHub Release](https://img.shields.io/github/v/release/jethrokuan/org-roam)](https://img.shields.io/github/v/release/jethrokuan/org-roam) +[![MELPA](https://melpa.org/packages/org-roam-badge.svg)](https://melpa.org/#/org-roam) ## Synopsis @@ -22,6 +23,7 @@ Important links: - **[Documentation][docs]** - **[Org-roam Slack][slack]** + ## A Preview Here's a screenshot of `org-roam`. The `org-roam` buffer shows @@ -34,13 +36,18 @@ structure, and can be used to navigate to the respective files. ## Installation -The recommended method is using use-package and straight, or a similar package manager. +You can install `org-roam` using `package.el`: + +``` +M-x package-install RET org-roam RET +``` + +Here's a sample configuration with using `use-package`: ```emacs-lisp (use-package org-roam :hook (after-init . org-roam-mode) - :straight (:host github :repo "jethrokuan/org-roam") :custom (org-roam-directory "/path/to/org-files/") :bind (:map org-roam-mode-map @@ -51,9 +58,9 @@ The recommended method is using use-package and straight, or a similar package m (("C-c n i" . org-roam-insert)))) ``` -For more detailed installation instructions (including instructions for -Spacemacs users), please see [the installation -documentation](https://org-roam.readthedocs.io/en/develop/installation/). +For more detailed installation and configuration instructions (including for +Doom and Spacemacs users), please see [the +documentation](https://org-roam.readthedocs.io/en/master/installation/). ## Knowledge Bases using Org-roam diff --git a/doc/installation.md b/doc/installation.md index 86a0f5e..4ed5c7b 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -1,12 +1,21 @@ -## Basic Install -The recommended method is using [use-package][use-package] and -[straight][straight], or a similar package manager. +## Basic Install and Configuration + +Org-roam is now available on MELPA, so you can install it via the following +command: + +``` +M-x package-install RET org-roam RET +``` + +Alternatively, you may use package managers such as [straight][straight] or +[quelpa][quelpa] to install the package. + +The recommended method of configuration is to use [use-package][use-package]. ```emacs-lisp (use-package org-roam :hook (after-init . org-roam-mode) - :straight (:host github :repo "jethrokuan/org-roam") :custom (org-roam-directory "/path/to/org-files/") :bind (:map org-roam-mode-map @@ -18,34 +27,9 @@ The recommended method is using [use-package][use-package] and (("C-c n i" . org-roam-insert)))) ``` -If not using package.el, you can also clone it into your Emacs -directory and add it to your load path: - -``` -git clone https://github.com/jethrokuan/org-roam/ ~/.emacs.d/elisp/org-roam -``` - -```emacs-lisp -(use-package org-roam - :load-path "elisp/" - :hook - (after-init . org-roam-mode) - :straight (:host github :repo "jethrokuan/org-roam") - :custom - (org-roam-directory "/path/to/org-files/") - :bind (:map org-roam-mode-map - (("C-c n l" . org-roam) - ("C-c n f" . org-roam-find-file) - ("C-c n b" . org-roam-switch-to-buffer) - ("C-c n g" . org-roam-show-graph)) - :map org-mode-map - (("C-c n i" . org-roam-insert)))) -``` - Or without `use-package`: ```emacs-lisp -(add-to-list 'load-path "./elisp") (require 'org-roam) (define-key org-roam-mode-map (kbd "C-c n l") #'org-roam) (define-key org-roam-mode-map (kbd "C-c n f") #'org-roam-find-file) @@ -58,12 +42,10 @@ Or without `use-package`: The [Configuration](configuration.md) page details some of the common configuration options available. -[use-package]: https://github.com/jwiegley/use-package -[straight]: https://github.com/raxod502/straight.el +## Spacemacs -### Spacemacs -If you are using Spacemacs, install org-roam by creating a simple -layer that wraps Org-roam. Paste the following into a new file +If you are using Spacemacs, install org-roam by creating a simple layer that +wraps Org-roam. Paste the following into a new file `~/.emacs.d/private/org-roam/packages.el`. ```emacs-lisp @@ -101,9 +83,10 @@ list in your `.spacemacs` configuration file. Reload (`SPC f e R`) or restart Emacs to load `org-roam`. It's functions are available under the prefix `SPC a r` and `, r` when visiting an org-mode buffer. -### Doom Emacs +## Doom Emacs -If you are using [Doom Emacs](https://github.com/hlissner/doom-emacs), configure packages as explained in the [getting started](https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#configuring-packages) guide. +If you are using [Doom Emacs][doom], configure packages as explained in the +[getting started][doom-getting-started] guide. Declare Org-roam as a package in your `~/.doom.d/packages.el`: @@ -131,28 +114,8 @@ Subsequently, in your `~/.doom.d/config.el` file, configure Org-roam: (org-roam-mode +1)) ``` -## Completion Support - -Org-roam supports inserting links on-the-fly via [company-mode](http://company-mode.github.io/). This is achieved by providing the company backend `company-org-roam`. - -![company-org-roam](images/company-org-roam.gif) - -You may install it the following way using straight: - -```emacs-lisp -(use-package company-org-roam - :straight nil - :after org-roam company org - :config - (company-org-roam-init)) -``` - -or simply: - -```emacs-lisp -(with-eval-after-load 'org-roam - (with-eval-after-load 'company - (with-eval-after-load 'org - (require 'company-org-roam) - (company-org-roam-init)))) -``` +[use-package]: https://github.com/jwiegley/use-package +[straight]: https://github.com/raxod502/straight.el +[quelpa]: https://github.com/quelpa/quelpa +[doom]: https://github.com/hlissner/doom-emacs +[doom-getting-started]: https://github.com/hlissner/doom-emacs/blob/develop/docs/getting_started.org#configuring-packages diff --git a/org-roam.el b/org-roam.el index 51435a6..db72ca5 100644 --- a/org-roam.el +++ b/org-roam.el @@ -769,7 +769,7 @@ applies. "Expands the template STR, returning the string. This is an extension of org-capture's template expansion. -First, it expands ${var} occurences in STR, using the INFO alist. +First, it expands ${var} occurrences in STR, using the INFO alist. If there is a ${var} with no matching var in the alist, the value of var is prompted for via `completing-read'. @@ -1137,7 +1137,7 @@ INFO is an alist containing additional information." (defun org-roam--roam-link-face (path) "Conditional face for org file links. -Applies `org-roam-link-face' if PATH correponds to a Roam file." +Applies `org-roam-link-face' if PATH corresponds to a Roam file." (if (org-roam--org-roam-file-p path) 'org-roam-link 'org-link)) @@ -1319,7 +1319,7 @@ Valid states are 'visible, 'exists and 'none." :group 'org-roam) (defcustom org-roam-graphviz-extra-options nil - "Extra options when contructing the Graphviz graph. + "Extra options when constructing the Graphviz graph. Example: '((\"rankdir\" . \"LR\"))" :type '(alist)