obsidian

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package obsidian defines directory, file, and MOC page constants for Obsidian vault generation.

Index

Constants

View Source
const (
	// DirName is the default output directory for the Obsidian vault
	// within .context/.
	DirName = "journal-obsidian"
	// DirEntries is the subdirectory for journal entry files.
	DirEntries = "entries"
	// DirConfig is the Obsidian configuration directory name.
	DirConfig = ".obsidian"
)

Obsidian vault output directory constants.

View Source
const (
	// WikilinkFmt formats a wikilink with display text.
	// Args: target, display.
	WikilinkFmt = "[[%s|%s]]"
	// WikilinkPlain formats a plain wikilink (no display text).
	// Args: target.
	WikilinkPlain = "[[%s]]"
)

Obsidian wikilink format templates.

View Source
const (
	// MOCPrefix is prepended to MOC filenames so they sort first
	// in the Obsidian file explorer.
	MOCPrefix = "_"
	// MOCHome is the root navigation hub filename.
	MOCHome = "Home.md"
	// MOCTopics is the topics index MOC filename.
	MOCTopics = "_Topics.md"
	// MOCFiles is the key files index MOC filename.
	MOCFiles = "_Key Files.md"
	// MOCTypes is the session types index MOC filename.
	MOCTypes = "_Session Types.md"
)

Obsidian MOC (Map of Content) page filenames.

View Source
const (
	// AppConfig is the minimal app.json content that enforces
	// wikilink mode and shows frontmatter properties.
	AppConfig = `{
  "useMarkdownLinks": false,
  "showFrontmatter": true,
  "strictLineBreaks": false
}
`
)

Obsidian vault configuration content.

View Source
const (
	// AppConfigFile is the Obsidian app configuration filename.
	AppConfigFile = "app.json"
)

Obsidian file constants.

View Source
const MaxRelated = 5

MaxRelated is the maximum number of "see also" entries in the related sessions footer.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL