org roam

Org-roam

Org-ROAM é um sistema de gerenciamento de conhecimento em texto simples. Ele traz alguns dos recursos mais poderosos de Roam para o ecossistema de modo de organização.

Org-ROAM empresta princípios do método Zettelkasten, fornecendo uma solução para anotações não hierárquicas. Também deve funcionar como uma solução plug-and-play para quem já usa o modo de organização para o seu wiki pessoal.

• Privado e seguro : edite seu wiki pessoal completamente offline, inteiramente sob seu controle. Criptografar suas anotações com GPG. Tome notas duradouras em texto simples.
• Pensamento em rede : conecte notas e pensamentos junto com facilidade usando backlinks. Descubra conexões surpreendentes e anteriormente invisíveis em suas anotações com a visualização de gráficos embutida.
• Extensible e poderoso : alavancar a fantástica interface de edição de texto do Emacs e o ecossistema EMACS maduro e os pacotes de modos de organização.
• GRATUITO ARGUNDO AND : Org-ROAM é licenciado sob a Licença Pública Geral da GNU versão 3 ou posterior.

• Documentação
• Discurso
• Folga
• Perguntas frequentes
• Changelog

Instalação

Abaixo, você encontrará instruções básicas de instalação sobre como instalar rapidamente org-roam usando vários ambientes para vários fins. Para informações mais detalhadas, leia o manual.

Usando package.el

Alternar instruções

Você pode instalar org-roam a partir de melpa ou melpa estável usando package.el :

 M-x package-install RET org-roam RET

Usando straight.el

Alternar instruções

Instalação de Melpa ou Melpa estável usando straight.el :

( straight-use-package 'org-roam )

Ou com use-package :

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

Se você precisar instalar o pacote diretamente do repositório de origem, em vez de da Melpa, a próxima amostra mostra como fazê -lo:

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

Se você planeja usar seu próprio garfo local para o desenvolvimento e a contribuição, a próxima amostra o levará até lá:

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

Usando o Doom Emacs

Alternar instruções

Doom :lang org vem com suporte para org-roam , mas não está ativado por padrão. Para ativá -lo, passe +roam2 para o módulo org no seu $DOOMDIR/init.el (por exemplo (org +roam2) ), salve o arquivo e execute doom sync -u no seu shell.

Para proporcionar uma melhor estabilidade, a Doom pin no pacote para uma confirmação específica. Se você precisar desconhecê -lo (não recomendado, solicite a Doom para aumentar o pacote) use o próximo em seus packages.el :

(unpin! org-roam)

Se, por alguns motivos, você deseja usar uma receita diferente para org-roam , você poderá usar o próximo formulário em seus packages.el .

(package! org-roam)

Você pode passar :pin "commit hash" para fixar o pacote em uma confirmação específica.

Com a próxima amostra, você pode instalar o pacote diretamente no repositório de origem:

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

E se você planeja usar seu próprio garfo local para o desenvolvimento ou contribuição, a próxima amostra o levará até lá:

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

Sem um gerente de pacotes

Alternar instruções

Para instalar o pacote sem usar um gerenciador de pacotes, você tem as próximas duas opções:

1. Instale o pacote clonando -o com git no repositório de origem.
2. Ou instale o pacote baixando a versão mais recente de lançamento.

Nos dois casos, você precisará garantir que tenha todas as dependências necessárias. Estes incluem:

• traço
• f
• s
• Org (9.4 é a versão mínima necessária!)
• Emacsql
• Emacsql-sqlite
• seção de magitos
• FileNotify-Recursive

Depois de instalar o pacote, você precisará configurar corretamente load-path no pacote:

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

Depois disso, você poderá resolver (require 'org-roam) sem problemas.

Org-ROAM também vem com arquivos .texi para se integrar ao sistema de informações internas da EMACS. Leia o manual para encontrar mais detalhes sobre como instalá -los manualmente.

Configuração

Aqui está uma amostra muito básica para a configuração de org-roam usando 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 ))

Observe que a função file-truename é necessária apenas quando você usa o link simbólico para org-roam-directory . Org-ROAM não resolverá automaticamente o link simbólico para o diretório.

Começando

David Wilson, da System Crafters, produziu um vídeo introdutório que cobre os comandos básicos:

Obtendo ajuda

Antes de criar um novo tópico/problema, esteja atento ao nosso tempo e verifique se ele ainda não foi abordado no Github ou no discurso.

• Se você é novo no EMACS e tem problemas para a configuração de org-roam, faça sua pergunta no Slack, canal #como fazer-i.
• Para perguntas rápidas, pergunte -lhes no Slack, canal #troubleblooting.
• Se algo não estiver funcionando como deveria, ou se você deseja sugerir um novo recurso, crie um novo problema.
• Se você tiver dúvidas sobre o seu fluxo de trabalho com o método Slip-Box, encontre um tópico relevante no discurso ou crie um novo.

Bases de conhecimento usando org-roam

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

Contribuindo

Para relatar bugs e sugerir novos recursos, use o rastreador de problemas. Se você tiver algum código que gostaria de ser mesclado, abra uma solicitação de tração. Por favor, consulte também contribuindo.md.

Licença

Copyright © Jethro Kuan e colaboradores. Distribuído sob a licença pública geral da GNU, versão 3.