md-graph

Graph operations on a collection of interlinked Markdown (or VimWiki, ZimWiki, Zettlr, Obsidian, or Neuron) notes.

md-graph seeks to enrich an existing library of interlinked notes but not change how notes are written for the sake of its use. This enables interoperation with other note systems as well as respecting note libraries that strive to remain evergreen by staying simple.

Usage

md-graph - A utility for graph operations on a collection of markdown files

Usage: md-graph [(-l|--library FILE|DIR)] [-d|--default-ext EXT] COMMAND

Available options:
  -h,--help                Show this help text
  -l,--library FILE|DIR    Files or directories to parse
  -d,--database FILE       Sqlite database file to use
  -x,--default-ext EXT     Default extension to use for files linked without
                           extension (default: "md")

Available commands:
  subgraph                 The subgraph of a node
  backlinks                The backlinks (reverse subgraph) of a node
  unreachable              Files that are not linked to
  orphans                  Files without any links
  nonexistant              Links that cannot be resolved
  static                   Links that can be resolved but are not notes
  populate                 Just populate the database

-l, --library Optional, defaults to the current working directory. The folders or files to include in the graph. Folders will be recursively searched.
-d, --database Optional, defaults to creating a temporary mdgraphXXXX file.
-d, --default-extension Default md. Extension to use for links that do not specify an extension (like WikiLinks and VimWiki markdown links)

Subgraph

A subgraph is the graph of a file built by following its links, its links' links, etc. If foo.md links to bar.md and baz.md, and bar.md links to qux.md, the subgraph of foo.md will be foo.md bar.md baz.md qux.md

Usage: md-graph subgraph NODES [--inc-nonex True|False] [--inc-static True|False]
                               [--tag-direction In|Out|Both] [--depth ARG]
  The subgraph of a node

Available options:
  NODES                    Nodes (files or #tags) to process
  --inc-nonex True|False   Include non-existent files in output (default: False)
  --inc-static True|False  Include static files in output (default: True)
  --tag-direction In|Out|Both
                           Change the direction of tags (default: Out)
  --depth ARG              How deep traversal should go (default: -1)
  -h,--help                Show this help text

NODES The target files or tags to act as the start of the subgraph.
--inc-static=True|False Default True. Includes static files in the output (files that were linked to and can be resolved)
--inc-nonex=True|False Default False. Includes non-existent files in the output (files that were linked to but can not be resolved - includes HTTP links)
--tag-direction=In|Out|Both Default Out. Controls how tags are added to the graph from the perspective of the tag.
- In: The link is coming in to the tag from the file
- Out: The link is from the tag out to the file
- Both: The tag and the file both have links to each other.
--depth INT Default -1 (infinite depth). Configures how many links deep from the target NODES a subgraph should traverse.

Backlinks

Backlinks are the files that link to a given file. foo.md is a backlink of bar.md if foo.md links to bar.md. It can also be thought of as the local subgraph of a file with the arrows reversed.

Usage: md-graph backlinks NODES [--depth ARG]
  The backlinks (reverse subgraph) of a node

Available options:
  NODES                    Nodes (files or #tags) to process
  --depth ARG              How deep traversal should go (default: 1)
  -h,--help                Show this help text

NODES The target files or tags to act as the start of the subgraph.
--depth INT Default 1 (immediate links only). Configures how many links deep from the target NODES a subgraph should traverse.

Nodes: Files & Tags

Arguments that take a "NODE" (such as subgraph and backlinks) can be given either a file or a tag. Tags are given by including the hash just like their file-parsed counterparts. The following will attempt to find the backlinks of the tag "my-special-tag": md-graph backlinks #my-special-tag.

With option --tag-direction=Out, you can find the subgraph of a tag.

Everything else will be parsed as a file.

Installation

Follow the instructions here to install stack

git clone https://github.com/CharlesSchimmel/md-graph
cd md-graph
stack install

Supported Formats

Link Formats

Because this merely parses out links, any format that uses markdown or wikilink style links should work. Links that are escaped or encoded in a way that is different from their filesystem name will not be traversed correctly.

Tag Format

Tags that follow the form of a hash ('#') followed by alpha-nums, dash, and underscores will be parsed as nodes. For example, this tag is valid: #someSort-of_tag123.

Background

I have a directory of notes in markdown format that link to each other like a Wiki. Sometimes I want to publish my notes on a given topic or group of topics including all of the related notes that they link to. For example, I might want to publish only my kombucha notes from my collection of notes on cooking. It would be a pain to have to manually trace the links between them in order to extract just the pertinent ones. This will take a root markdown file and traverse its links, returning all of the files necessary to complete its subgraph.

charlesschimmel / md-graph Goto Github PK

md-graph's Introduction

md-graph

Usage

Subgraph

Backlinks

Nodes: Files & Tags

Installation

Supported Formats

Link Formats

Tag Format

Background

md-graph's People

Contributors

Stargazers

Watchers

md-graph's Issues

Recommend Projects

Recommend Topics

Recommend Org