org roam

Orgiral

Org-roam es un sistema de gestión de conocimiento de texto sencillo. Trae algunas de las características más poderosas de Roam al ecosistema de modo Org.

Org-Roam toma prestados principios del método Zettelkasten, proporcionando una solución para la toma de notas no jerárquicas. También debe funcionar como una solución plug-and-play para cualquier persona que ya use Modo de orgía para su wiki personal.

• Privado y seguro : edite su wiki personal completamente fuera de línea, completamente bajo su control. Cifre sus notas con GPG. Tome notas duraderas en texto sencillo.
• Pensamiento en red : conecte notas y pensamientos junto con facilidad usando vínculos de retroceso. Descubra conexiones sorprendentes y previamente invisibles en sus notas con la visualización de gráficos incorporado.
• Extensible y potente : aprovechar la fantástica interfaz de edición de texto de Emacs, y los emacs maduros y el ecosistema de paquetes en modo de organización.
• FUERTE GRATUITO y abierto : Org-Roam tiene licencia bajo la Licencia Pública General de GNU versión 3 o posterior.

• Documentación
• Discurso
• Flojo
• Preguntas frecuentes
• Colegio de cambios

Instalación

A continuación, encontrará instrucciones básicas de instalación sobre cómo instalar rápidamente org-roam utilizando varios entornos para diversos fines. Para obtener información más detallada, lea el manual.

Usando package.el

Instrucciones de alternar

Puede instalar org-roam desde MelPA o Melpa Stable usando package.el :

 M-x package-install RET org-roam RET

Usando straight.el

Instrucciones de alternar

Instalación desde MelPA o MelPA Stable con straight.el :

( straight-use-package 'org-roam )

O con use-package :

( use-package org-roam
  :straight t
  ...)

Si necesita instalar el paquete directamente desde el repositorio de origen, en lugar de desde MelPA, la siguiente muestra muestra cómo hacerlo:

( use-package org-roam
  :straight ( :host github :repo " org-roam/org-roam "
             :files ( :defaults " extensions/* " ))
  ...)

Si planea usar su propia horquilla local para el desarrollo y la contribución, la próxima muestra lo llevará allí:

( use-package org-roam
  :straight ( :local-repo " /path/to/org-roam-fork "
             :files ( :defaults " extensions/* " )
             :build ( :not compile))
  ...)

Usando emacs de Doom

Instrucciones de alternar

Doom's :lang org viene con soporte para org-roam , pero no está habilitado de forma predeterminada. Para activarlo, pase el indicador de +roam2 para org el módulo en su $DOOMDIR/init.el (por ejemplo (org +roam2) ), guarde el archivo y ejecute doom sync -u en su shell.

Para proporcionar una mejor estabilidad, Doom limita el paquete a una confirmación específica. Si necesita descargarlo (no se recomienda hacerlo, solicite a Doom para que aumente el paquete) use el siguiente en sus packages.el .

(unpin! org-roam)

Si por algunas razones desea utilizar una receta diferente para org-roam , puede usar el siguiente formulario en sus packages.el para instalar el paquete desde un repositorio de recetas (por ejemplo, MELPA):

(package! org-roam)

Puede pasar :pin "commit hash" para fijar el paquete a una confirmación específica.

Con la siguiente muestra, puede instalar el paquete directamente desde el repositorio de origen:

(package! org-roam
  :recipe ( :host github :repo " org-roam/org-roam "
           :files ( :defaults " extensions/* " )))

Y si planea usar su propia horquilla local para el desarrollo o la contribución, la próxima muestra lo llevará allí:

(package! org-roam
  :recipe ( :local-repo " /path/to/org-roam-fork "
           :files ( :defaults " extensions/* " )
           :build ( :not compile)))

Sin un administrador de paquetes

Instrucciones de alternar

Para instalar el paquete sin usar un administrador de paquetes, tiene las siguientes dos opciones:

1. Instale el paquete clonándolo con git desde el repositorio de origen.
2. O instale el paquete descargando la última versión de lanzamiento.

En ambos casos, deberá asegurarse de tener todas las dependencias requeridas. Estos incluyen:

• estrellarse
• F
• s
• org (9.4 es la versión mínima requerida!)
• emacsql
• emacsql-sqlite
• sección magit
• FileNotify-RECURSIVO

Después de instalar el paquete, deberá configurar correctamente load-path en el paquete:

( add-to-list 'load-path " /path/to/org-roam/ " )
( add-to-list 'load-path " /path/to-org-roam/extensions/ " )

Después de lo cual debe poder resolver (require 'org-roam) sin ningún problema.

Org-Roam también viene con archivos .texi para integrarse con el sistema de información incorporado de Emacs. Lea el manual para encontrar más detalles sobre cómo instalarlos manualmente.

Configuración

Aquí hay una muestra muy básica para la configuración de org-roam utilizando use-package :

( use-package org-roam
  :ensure t
  :custom
  (org-roam-directory ( file-truename " /path/to/org-files/ " ))
  :bind (( " C-c n l " . org-roam-buffer-toggle)
         ( " C-c n f " . org-roam-node-find)
         ( " C-c n g " . org-roam-graph)
         ( " C-c n i " . org-roam-node-insert)
         ( " C-c n c " . org-roam-capture)
         ; ; Dailies
         ( " C-c n j " . org-roam-dailies-capture-today))
  :config
  ; ; If you're using a vertical completion framework, you might want a more informative completion interface
  ( setq org-roam-node-display-template ( concat " ${title:*} " ( propertize " ${tags:10} " 'face 'org-tag )))
  (org-roam-db-autosync-mode)
  ; ; If using org-roam-protocol
  ( require 'org-roam-protocol ))

Tenga en cuenta que la función file-truename solo es necesaria cuando usa un enlace simbólico al org-roam-directory . Org-roam no resolverá automáticamente el enlace simbólico al directorio.

Empezando

David Wilson de System Crafters ha producido un video introductorio que cubre los comandos básicos:

Obtener ayuda

Antes de crear un nuevo tema/problema, tenga en cuenta nuestro tiempo y asegúrese de que aún no se haya abordado en Github o en el discurso.

• Si es nuevo en Emacs y tiene problemas para configurar Org-Roam, haga su pregunta en Slack, Channel #How-do-i.
• Para preguntas rápidas, pregúnteles en Slack, canal #TrooblesShooting.
• Si algo no funciona como debería, o si desea sugerir una nueva característica, cree un nuevo problema.
• Si tiene preguntas sobre su flujo de trabajo con el método Slip-Box, busque un tema relevante en el discurso o cree uno nuevo.

Bases de conocimiento usando org-roam

• Jethro Kuan (fuente)
• Alexey Shmalko
• Sidharth Arya
• Martin Edström

Que contribuye

Para informar errores y sugerir una nueva función Use el rastreador de problemas. Si tiene algún código que le gustaría fusionarse, abra una solicitud de extracción. Por favor, vea también contributive.md.

Licencia

Copyright © Jethro Kuan y colaboradores. Distribuido bajo la Licencia Pública General de GNU, versión 3.