Documentation
¶
Overview ¶
Package obsidian implements the ctx journal obsidian subcommand.
It generates an Obsidian vault from journal entries, enabling visual exploration of session history.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func BuildObsidianVault ¶
BuildObsidianVault generates an Obsidian vault from journal entries in journalDir and writes the output to the output directory.
Parameters:
- cmd: Cobra command for output stream
- journalDir: Path to the source journal directory
- output: Output directory for the vault
Returns:
- error: Non-nil if generation fails
func Cmd ¶
Cmd returns the journal obsidian subcommand.
Returns:
- *cobra.Command: Command for generating an Obsidian vault from journal entries
func Run ¶
Run generates an Obsidian vault from journal entries.
Pipeline:
- Scan entries (reuse core.ScanJournalEntries)
- Create output dirs (entries/, topics/, files/, types/, .obsidian/)
- Write .obsidian/app.json
- Transform and write entries (normalize, convert links, transform frontmatter, add related footer)
- Build indices (reuse core.BuildTopicIndex etc.)
- Generate and write MOC pages
- Generate and write Home.md
Parameters:
- cmd: Cobra command for output stream
- output: Output directory for the vault
Returns:
- error: Non-nil if generation fails
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.