orgnote.el

orgnote.el copied to clipboard

:PROPERTIES: :ID: orgnote.el :END:

#+html:

#+html: #+html:

#+TITLE: ✨ OrgNote.el

#+html:

#+html: #+html: #+html: #+html:

#+html: #+html: #+html: #+html:

#+html: #+html: #+html: #+html: #+html: #+html: #+html:

#+html: #+html: #+html: #+html:

• Introduction orgnote.el is a package for synchronizing your org-roam notes, or just org files with property id from emacs with an external application - [[https://org-note.com][orgnote]] and vice versa. For correct usage you need to have API and activation key #+html:

  #+html: #+html:
  #+html:  

• Connected links

• [[https://github.com/Artawower/orgnote][OrgNote app. Main repo]]

• Install ** Install dependencies

1. [[https://docs.npmjs.com/downloading-and-installing-node-js-and-npm/][Install npm]]
2. Install orgnote-cli Run =M-x orgnote-install-dependencies= or =npm install -g orgnote-cli=

** Doom ~package.el~ #+BEGIN_SRC emacs-lisp (package! orgnote :recipe (:host github :repo "artawower/orgnote.el")) #+END_SRC ~config.el~

#+BEGIN_SRC emacs-lisp (use-package! orgnote :defer t :hook (org-mode . orgnote-sync-mode)) #+END_SRC ** Straight #+BEGIN_SRC emacs-lisp (use-package orgnote :general (:states '(normal visual) :keymaps 'org-mode-map "SPC np" 'orgnote-publish-file)) #+END_SRC

• Usage ** Variables ~orgnote-debug-p~ - enable debug mode for additional logging. Consider enabling the flag when you create a bug-related question

~orgnote-configuration-file-path~ - path to the configuration file. Default is ~/.config/orgnote/config.json

~orgnote-execution-script~ - path to the execution script. Default is ~orgnote-cli~

=orgnote-enable-roam-sync-p= - enable org-roam sync. Default is =nil=

** Configuraiton Read more about CLI tool [[https://github.com/Artawower/orgnote-cli][here]]

• 🍩 Contribute guide Any contribution is very much appreciated! Please read the [[./CONTRIBUTE.org][style guide]] before contributing to avoid misunderstandings!

Also, the project exists solely on donations. I would appreciate it if you would join my patreon.