diff options
author | Gabriel <[email protected]> | 2024-09-19 08:25:38 -0300 |
---|---|---|
committer | Thanos Apollo <[email protected]> | 2024-09-19 17:18:04 +0300 |
commit | 28b4067319bb10fc208c1066ef306779419a5a2b (patch) | |
tree | 79cc2a4080d49f7143094a5f2ef5a5f56c91dc9f /doc | |
parent | 4041ef532d462a41410b8d11299ad14a79bf86e8 (diff) |
doc: New section: Interactions with other software.
* Add new sections for gnosis interactions with other software.
* Add interactions documentation with emacs-no-literring.
* Restracture sections.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gnosis.org | 71 |
1 files changed, 41 insertions, 30 deletions
diff --git a/doc/gnosis.org b/doc/gnosis.org index 19416ab..8054009 100644 --- a/doc/gnosis.org +++ b/doc/gnosis.org @@ -188,7 +188,6 @@ difference of at most one character edit. To demonstrate, 'example' and 'examples' will be recognized as similar, considering that the latter involves just one additional character." - * Gnosis Algorithm Each gnosis note has a gnosis score, which is a list of 3 values, @@ -241,35 +240,6 @@ it's next review date will be on the same date. + You can edit a note after review by pressing ~e~ + Open =gnosis-dashboard= with =M-x gnosis-dashboard=, find the note you want to edit and press ~e~ -* Sync between devices - -Gnosis uses git to maintain data integrity and facilitate -synchronization across devices. - -You will need to configure your remote manually. - -Example: - -#+begin_src bash - cd ~/.emacs.d/gnosis # default location for gnosis - git init # After completing your first review session, a git repo should have been initialized automatically. - git remote add origin <remote_url> - git push --set-upstream origin master -#+end_src - - -You can interactively use =gnosis-vc-push= & =gnosis-vc-pull=. As the -name suggests, they rely on =vc= to work properly. - -Depending on your setup, =vc= might require an external package for -the ssh passphrase dialog, such as ~x11-ssh-askpass~. - -To automatically push changes after a review session, add this to your configuration: -#+begin_src emacs-lisp -(setf gnosis-vc-auto-push t) -(gnosis-vc-pull) ;; Run vc-pull for gnosis on startup -#+end_src - * Configuring Note Types ** Custom Note Types Each gnosis note type has an /interactive/ function, named @@ -303,3 +273,44 @@ testing. To exit the testing environment, rerun =M-x gnosis-test-start= and then enter =n= (no) at the prompt "Start development env?" + +* Sync between devices + +Gnosis uses git to maintain data integrity and facilitate +synchronization across devices. + +You will need to configure your remote manually. + +Example: + +#+begin_src bash + cd ~/.emacs.d/gnosis # default location for gnosis, no-littering is ~/.emacs.d/var/gnosis + git init # After completing your first review session, a git repo should have been initialized automatically. + git remote add origin <remote_url> + git push --set-upstream origin master +#+end_src + + +You can interactively use =gnosis-vc-push= & =gnosis-vc-pull=. As the +name suggests, they rely on =vc= to work properly. + +Depending on your setup, =vc= might require an external package for +the ssh passphrase dialog, such as ~x11-ssh-askpass~. + +To automatically push changes after a review session, add this to your configuration: +#+begin_src emacs-lisp +(setf gnosis-vc-auto-push t) +(gnosis-vc-pull) ;; Run vc-pull for gnosis on startup +#+end_src + +* Interactions with other software +** emacs-no-littering + +If you are a user of [[https://github.com/emacscollective/no-littering][emacs-no-littering]], you can theme Gnosis to fit +its standards by adding the following snippet to your configuration: + +#+begin_src emacs-lisp +(setq gnosis-dir (no-littering-expand-var-file-name "gnosis/")) +#+end_src + +This sets =gnosis-dir= to =~/.emacs.d/var/gnosis=, in line with the folders of other packages. |