Experimental repository for CoGMDR project (Collaborative Graph-based Methods for Distributed Research), using Obsidian for graph construction.
Go to file
Ronen Tamari 2151c9d1c7 Merge branch 'main' of https://gitea.dgov.io/DGF/obsidian-dgraph into main 2023-08-28 08:42:08 -04:00
dgraph Merge branch 'main' of https://gitea.dgov.io/DGF/obsidian-dgraph into main 2023-08-28 08:42:08 -04:00
.gitignore Update .gitignore 2023-08-02 08:56:58 -04:00
README.md Update README.md 2023-07-31 16:05:47 -05:00

README.md

Set up prerequisites

Obsidian

  • Download Obsidian here.
  • Besides the core Obsidian, well also need to add the Juggl plugin to support labeled edges:
    • Go to Settings->Community plugins and click Turn on community plugins
    • Click Browse.
    • Type Juggl and click Install.
    • Make sure Juggl is active by toggling it in Settings->Community plugins->Installed plugins

Version Control (Git)

Well use Git for version control. If you already know how to use git, you can skip this section and directly clone the repository. If not, the easiest way to go is to use the Github Desktop GUI client.

  1. Download Github Desktop here and install it.

  2. In Github Desktop, go to File->Clone repository , click the URL tab and input the repo URL

    https://gitea.dgov.io/DGF/obsidian-dgraph.git
    
  3. To pull the most update version of the repo, click on “Fetch origin” and then “Pull origin” if there are new modifications.

  4. To add changes youve made to the graph, select the files you wish to commit and press “commit to main”.

  5. This is just a minimal overview of the basic git operations. For a more in depth look there are many great resources, for example https://think-like-a-git.net/

Usage

  • In Obsidian, click Open another vault and select the dgraph folder in the directory where you cloned the repository. On the left Files pane in Obsidian, you should now see the markdown pages comprising the knowledge graph.

  • To view the graph view in Juggl, right click a page and select Open Juggl

  • To add nodes to the graph, simply click the New note button above the list of pages on the left.

  • To add an unlabeled edge to the graph, add to the source node a link to the target node using:

    [[target-page-name]]
    

    (see example here)

  • To add a labeled edge, use the syntax:

    - edge_label [[target-page-name]]
    

    Where edge_label must be one word.

    (see example here)

  • Nodes and edges should follow the current graph grammar.