obsidian

Documentation

Overview

Package obsidian generates Obsidian vault exports from graph data.

Index

• func GenerateCommunity(comm analyze.Community, nodeMap map[string]*graph.Node, degrees map[string]int) string
• func GenerateIndex(nodes []*graph.Node, edges []*graph.Edge, godNodes []analyze.HubNode, ...) string
• func GenerateNode(node *graph.Node, outgoing, incoming map[string][]*graph.Edge, ...) string
• func SanitizeName(id string) string
• type Generator
  • func NewGenerator() *Generator
  • func (g *Generator) Generate(nodes []*graph.Node, edges []*graph.Edge) *VaultContent
• type VaultContent

Functions

func GenerateCommunity

func GenerateCommunity(comm analyze.Community, nodeMap map[string]*graph.Node, degrees map[string]int) string

GenerateCommunity creates a community page.

func GenerateIndex

func GenerateIndex(nodes []*graph.Node, edges []*graph.Edge, godNodes []analyze.HubNode, communities *analyze.ClusterResult) string

GenerateIndex creates the index.md content.

func GenerateNode

func GenerateNode(node *graph.Node, outgoing, incoming map[string][]*graph.Edge, nodeMap map[string]*graph.Node) string

GenerateNode creates a node page.

func SanitizeName

func SanitizeName(id string) string

SanitizeName creates a safe filename for Obsidian.

Types

type Generator

type Generator struct {
	// TopN is the number of top hub nodes to include.
	TopN int

	// MinDegree is the minimum degree for a node to get its own page.
	MinDegree int
}

Generator creates Obsidian markdown pages from graph data.

func NewGenerator

func NewGenerator() *Generator

NewGenerator creates a Generator with default settings.

func (*Generator) Generate

func (g *Generator) Generate(nodes []*graph.Node, edges []*graph.Edge) *VaultContent

Generate creates all content for an Obsidian vault.

type VaultContent

type VaultContent struct {
	Index       string
	Communities map[int]string    // community ID -> content
	Nodes       map[string]string // sanitized node ID -> content
}

VaultContent holds all generated content for an Obsidian vault.