# Functions
AppendLines append multiple lines in a file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AttributesString formats the current attributes to the YAML front matter format.
No description provided by the author
No description provided by the author
CastAttribute enforces the type declared in linter schemas.
CastAttributes enforces the types declared in linter schemas.
CheckAttribute implements the rule "check-attribute".
CompactYAML removes leading spaces in front of sequences.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DetectMediaKind returns the media kind based on a file path.
DetermineFileSlug generates a slug from a file path.
DetermineNoteSlug determines the note slug from the attributes.
No description provided by the author
EvaluateTimeExpression determine the next matching reminder date.
ExtractBlockTagsAndAttributes searches for all tags and attributes declared on standalone lines (in comparison with tags/attributes defined, for example, on To-Do list items).
FilterNonInheritableAttributes removes from the list all non-inheritable attributes.
FormatLongTitle formats the long title of a note.
FreezeAt wraps the clock API to register the cleanup function at the end of the test.
FreezeNow wraps the clock API to register the cleanup function at the end of the test.
GetSchemaAttributes calculates the list of declared attributes for a given note.
GetSchemaAttributeType returns the type for the given attribute and defaults to string if no declaration is found.
GetSchemaAttributeTypes returns all declared attributes with their JSON types.
No description provided by the author
InitConfigFromDirectory creates the .nt configuration directory with default files including .ntignore.
IsArray returns if a variable is a JSON array.
IsBool returns if a variable is a JSON boolean.
IsComposite returns if a variable is a composite type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IsFloat returns if a variable is a JSON number of float type.
IsInteger returns if a variable is a JSON number of integer type.
IsNumber returns if a variable is a JSON number.
IsObject returns if a variable is a JSON map.
IsPrimitive returns if a variable is a primitive type.
IsString returns if a variable is a JSON string.
MatchWikilink tests if a text is a wikilink.
MaxLinesBetweenNotes implements the rule "min-lines-between-notes".
No description provided by the author
No description provided by the author
MinLinesBetweenNotes implements the rule "min-lines-between-notes".
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
MustDeleteFile remove a file iin the current repository.
No description provided by the author
No description provided by the author
MustParseNote is pratical in unit test to setup a new note.
MustWriteBlob writes a new blob object or fails.
MustWriteFile edits the file in the current repository to force the given content.
No description provided by the author
NewCommit initializes a new empty commit.
NewCommitFromPackFiles initializes a new commit referencing the given pack files.
NewCommitGraph instantiates a new commit graph.
NewCommitGraphFromPath loads a commit-graph file from a path.
NewCommitWithOID initializes a new commit with a given OID.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewFlashcard initializes a new flashcard.
No description provided by the author
NewIndex instantiates a new index.
NewIndexFromPath loads an index file from a file.
No description provided by the author
No description provided by the author
NewMedia initializes a new media.
NewNote creates a new note from given attributes.
NewObjectData creates a compressed-string representation of the object.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOrExistingNote loads and updates an existing note or creates a new one if new.
No description provided by the author
NewPackFile initializes a new empty pack file.
NewPackFileFromPath reads a pack file file on disk or returns an empty instance.
NewPackFileRefWithOID initializes a new empty pack file ref with a given OID.
NewPackFileWithOID initializes a new empty pack file with a given OID.
NewQuery instantiates a new query.
NewRelation instantiates a new relation.
No description provided by the author
NewReminder instantiates a new reminder.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewStorjRemoteFromProject instantiates a client using a project (useful for testing purposes).
NewStorjRemoteWithCredentials instantiates a client using the access grant.
NewStudy creates a new study.
NewWikilink instantiates a new wikilink.
NoAmbiguousWikilink implements the rule "no-ambiguous-wikilink".
NoDanglingMedia implements the rule "no-dangling-media".
NoDeadWikilink implements the rule "no-dead-wikilink".
NoDuplicateNoteTitle implements the rule "no-duplicate-note-title".
NoDuplicateSlug implements the rule "no-duplicate-slug".
NoExtensionWikilink implements the rule "no-extension-wikilink".
NoFreeNote implements the rule "no-free-note".
NonInheritableAttributes returns the attributes that must not be inherited.
NoteTitleMatch implements the rule "note-title-match".
OIDToPath converts an oid to a file path.
ParseFile contains the main logic to parse a raw note file.
No description provided by the author
ParseMarkdownFile parses a Markdown file.
ParseMedias extracts raw paths from a file or note body content.
ParseNotes extracts the notes from a file body.
ParseQuery parses a user query.
ParseWikilinks extracts wikilinks from a text.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReadConfigFromDirectory loads the configuration by searching for a .nt directory in the given directory or any parent directories.
No description provided by the author
No description provided by the author
RemoveTagsAndAttributes removes all tags and attributes from a text.
ReplaceLine replaces a line inside a file.
RequireQuoteTag implements the rule "require-quote-tag".
Reset forces singletons to be recreated.
ResetOID restores the original unique OID generator.
SetNextOIDs configures a predefined list of OID.
No description provided by the author
SetUpRepositoryFromFileContent populates a temp directory based on the given file content.
SetUpRepositoryFromGoldenDir populates a temp directory containing a valid .nt repository.
SetUpRepositoryFromGoldenDir populates a temp directory based on the given golden dir name.
SetUpRepositoryFromGoldenFile populates a temp directory containing a valid .nt repository and a single file.
SetUpRepositoryFromGoldenFileNamed populates a temp directory based on the given golden file name.
SetUpRepositoryFromTempDir populates a temp directory containing a valid .nt repository.
StripTagsAndAttributes remove all tags and attributes.
No description provided by the author
No description provided by the author
UnescapeTestContent supports content using a special character instead of backticks.
UnmarshalAttributes unmarshall attributes and ensure the right types are used.
UseFixedOID configures a fixed OID value.
UseFixedOID configures a fixed OID value.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Default .nt/config content.
Same as Anki.
day.
Default .nt/.gitignore content.
Default .ntignore content.
No description provided by the author
SRS.
SRS.
SRS.
No description provided by the author
No description provided by the author
Anki-inspired feedbacks.
No description provided by the author
No description provided by the author
Used to bury a card to max interval.
Used to relearn a card from scratch.
Default indentation in front matter.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Maximum width and/or height for large blobs.
Database.
Same as Anki.
No description provided by the author
No description provided by the author
NoteLongTitleSeparator represents the separator when determine the long title of a note.
Maximum width and/or height for preview blobs.
in learning, next review in at least a day after the previous review.
learning/relearning.
new (never shown).
review (as for type).
leeches as manual suspension is not supported.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
List of supported audio formats.
No description provided by the author
IndexFilesFirst ensures index files are processed first.
No description provided by the author
List of supported picture formats.
List of supported picture formats.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
CommitGraph represents a .nt/objects/info/commit-graph file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Note: Fields must be public for toml package to unmarshall.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Index See https://git-scm.com/docs/index-format for inspiration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ParsedNote represents a single raw note inside a file.
ParsedNote represents a single raw note inside a file.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Wikilink is an internal link.
No description provided by the author
# Interfaces
Object groups method common to all kinds of managed objects.
No description provided by the author
Remote provides an abstraction in front of remote implementations.
Queryable provides a common interface between sql.DB and sql.Tx to make methods compatible with both.
StatefulObject to represent the subset of updatable objects persisted in database.
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LintRule describes the interface that rules must conform.
No description provided by the author
No description provided by the author
ObjectData serializes any Object to base64 after zlib compression.
Convenient type to add methods.
No description provided by the author
No description provided by the author
State describes an object status.
No description provided by the author