mirror of
https://github.com/org-roam/org-roam
synced 2025-09-28 16:50:58 -05:00
(internal): use emacsql-sqlite3 everywhere (#701)
This commit is contained in:
@@ -55,9 +55,11 @@ Org-roam provides several benefits over other tooling:
|
||||
- Free and Open Source :: Org-roam is free and open-source, which means that if you feel unhappy with any part of Org-roam, you may choose to extend Org-roam, or open a PR.
|
||||
- Leverages the Org-mode ecosystem :: Over the years, Emacs and Org-mode has developed into a mature system for plain-text organization. Building upon Org-mode already puts Org-roam light-years ahead of many other solutions.
|
||||
- Built on Emacs :: Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs.
|
||||
|
||||
* Installation
|
||||
** _ :ignore:
|
||||
Org-roam can be installed using Emacs' package manager or manually from its development repository.
|
||||
|
||||
Org-roam can be installed using Emacs' package manager or manually from its
|
||||
development repository.
|
||||
|
||||
** Installing from MELPA
|
||||
|
||||
@@ -97,7 +99,15 @@ Now see [[*Post-Installation Tasks][Post-Installation Tasks]].
|
||||
|
||||
** TODO Installing from the Git Repository
|
||||
|
||||
** TODO Post-Installation Tasks
|
||||
** Post-Installation Tasks
|
||||
|
||||
Org-roam uses ~emacsql-sqlite3~, which requires ~sqlite3~ to be located on
|
||||
~exec-path~. Please ensure that ~sqlite3~ is installed appropriately on your
|
||||
operating system. You can verify that this is the case by executing:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(executable-find "sqlite3")
|
||||
#+END_SRC
|
||||
|
||||
* Getting Started
|
||||
|
||||
|
@@ -78,14 +78,13 @@ General Public License for more details.
|
||||
* Diagnosing and Repairing Files::
|
||||
* Appendix::
|
||||
* FAQ::
|
||||
* _: _ (2).
|
||||
* _: _ (1).
|
||||
|
||||
@detailmenu
|
||||
--- The Detailed Node Listing ---
|
||||
|
||||
Installation
|
||||
|
||||
* _::
|
||||
* Installing from MELPA::
|
||||
* Installing from the Git Repository::
|
||||
* Post-Installation Tasks::
|
||||
@@ -119,7 +118,7 @@ Graphing
|
||||
|
||||
Roam Protocol
|
||||
|
||||
* _: _ (1).
|
||||
* _::
|
||||
* Installation: Installation (1).
|
||||
* The @samp{roam-file} protocol::
|
||||
* The @samp{roam-ref} Protocol::
|
||||
@@ -179,18 +178,15 @@ Emacs is also a fantastic interface for editing text, and we can inherit many of
|
||||
@node Installation
|
||||
@chapter Installation
|
||||
|
||||
Org-roam can be installed using Emacs' package manager or manually from its
|
||||
development repository.
|
||||
|
||||
@menu
|
||||
* _::
|
||||
* Installing from MELPA::
|
||||
* Installing from the Git Repository::
|
||||
* Post-Installation Tasks::
|
||||
@end menu
|
||||
|
||||
@node _
|
||||
@section _ :ignore:
|
||||
|
||||
Org-roam can be installed using Emacs' package manager or manually from its development repository.
|
||||
|
||||
@node Installing from MELPA
|
||||
@section Installing from MELPA
|
||||
|
||||
@@ -238,7 +234,15 @@ Now see @ref{Post-Installation Tasks}.
|
||||
@section @strong{TODO} Installing from the Git Repository
|
||||
|
||||
@node Post-Installation Tasks
|
||||
@section @strong{TODO} Post-Installation Tasks
|
||||
@section Post-Installation Tasks
|
||||
|
||||
Org-roam uses @code{emacsql-sqlite3}, which requires @code{sqlite3} to be located on
|
||||
@code{exec-path}. Please ensure that @code{sqlite3} is installed appropriately on your
|
||||
operating system. You can verify that this is the case by executing:
|
||||
|
||||
@lisp
|
||||
(executable-find "sqlite3")
|
||||
@end lisp
|
||||
|
||||
@node Getting Started
|
||||
@chapter Getting Started
|
||||
@@ -840,13 +844,13 @@ Other options include @samp{'ido}, and @samp{'ivy}.
|
||||
@chapter Roam Protocol
|
||||
|
||||
@menu
|
||||
* _: _ (1).
|
||||
* _::
|
||||
* Installation: Installation (1).
|
||||
* The @samp{roam-file} protocol::
|
||||
* The @samp{roam-ref} Protocol::
|
||||
@end menu
|
||||
|
||||
@node _ (1)
|
||||
@node _
|
||||
@section _ :ignore:
|
||||
|
||||
Org-roam extending @samp{org-protocol} with 2 protocols: the @samp{roam-file}
|
||||
@@ -1238,7 +1242,7 @@ etc.) within Org-mode.
|
||||
@node Bibliography
|
||||
@unnumberedsubsubsec Bibliography
|
||||
|
||||
@uref{https://github.com/zaeph/org-roam-bibtex, org-roam-bibtex} offers
|
||||
@uref{https://github.com/org-roam/org-roam-bibtex, org-roam-bibtex} offers
|
||||
tight integration between
|
||||
@uref{https://github.com/jkitchin/org-ref, org-ref},
|
||||
@uref{https://github.com/tmalsburg/helm-bibtex, helm-bibtex} and
|
||||
@@ -1280,7 +1284,7 @@ All files within that directory will be treated as their own separate
|
||||
set of Org-roam files. Remember to run @samp{org-roam-db-build-cache} from a
|
||||
file within that directory, at least once.
|
||||
|
||||
@node _ (2)
|
||||
@node _ (1)
|
||||
@chapter _ :ignore:
|
||||
|
||||
Emacs 28.0.50 (Org mode 9.4)
|
||||
|
Reference in New Issue
Block a user