notes

package

v0.0.0-...-b7c9c45 Latest Latest Go to latest Published: Apr 5, 2025 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/RaghavSood/collectibles

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DeriveNotePath(noteType NoteType, elements ...string) (string, error)
func ReadNoteFile(file fs.File) (string, error)
func RenderNote(content string) string
type Note
- func ReadNotes(pointers []NotePointer) []Note
type NotePointer
type NoteType

Constants ¶

This section is empty.

Variables ¶

View Source

var NotesFS embed.FS

Functions ¶

func DeriveNotePath ¶

func DeriveNotePath(noteType NoteType, elements ...string) (string, error)

func ReadNoteFile ¶

func ReadNoteFile(file fs.File) (string, error)

func RenderNote ¶

func RenderNote(content string) string

Types ¶

type Note ¶

type Note struct {
	NoteID       string   `json:"note_id"`
	Type         NoteType `json:"type"`
	Data         string   `json:"data"`
	Path         string   `json:"path"`
	PathElements []string `json:"path_elements"`
}

func ReadNotes ¶

func ReadNotes(pointers []NotePointer) []Note

type NotePointer ¶

type NotePointer struct {
	NoteType     NoteType `json:"note_type"`
	PathElements []string `json:"path_elements"`
}

type NoteType ¶

type NoteType string

const (
	Creator NoteType = "creator"
	Series  NoteType = "series"
	Item    NoteType = "item"
)

Source Files ¶

View all Source files

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