topic

package
v0.0.5 Latest Latest
Warning

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

Go to latest
Published: Apr 14, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package topic scaffolds, lists, and retrieves metadata for knowledge base topics within a vault.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func EnsureCurrentSkeleton added in v0.0.4

func EnsureCurrentSkeleton(topicPath string) error

EnsureCurrentSkeleton creates the current topic directory structure without modifying topic marker files or templates.

func Info

func Info(vaultPath, slug string) (models.TopicInfo, error)

Info returns topic metadata for one scaffolded topic.

func List

func List(vaultPath string) ([]models.TopicInfo, error)

List returns the topics discovered under the provided vault root.

func New

func New(vaultPath, slug, title, domain string) (models.TopicInfo, error)

New scaffolds a new topic underneath the provided vault root.

func RenderClaudeTemplate added in v0.0.5

func RenderClaudeTemplate(slug, title, domain, today string) (string, error)

RenderClaudeTemplate renders the default topic CLAUDE.md content for the provided topic metadata. Callers can append managed sections afterwards.

func RenderConceptIndexTemplate added in v0.0.5

func RenderConceptIndexTemplate(slug, title, domain, today string) (string, error)

RenderConceptIndexTemplate renders the default top-level Concept Index scaffold.

func RenderDashboardTemplate added in v0.0.5

func RenderDashboardTemplate(slug, title, domain, today string) (string, error)

RenderDashboardTemplate renders the default top-level Dashboard.md scaffold.

func RenderSourceIndexTemplate added in v0.0.5

func RenderSourceIndexTemplate(slug, title, domain, today string) (string, error)

RenderSourceIndexTemplate renders the default top-level Source Index scaffold.

Types

This section is empty.

Jump to

Keyboard shortcuts

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