View Source API Reference Magma v0.2.0

Modules

Magma is an environment for writing and executing complex prompts.

Magma.Artefact is a behaviour for defining different types of artefacts.

The basic Magma document type used for generating concrete artefacts.

Cache for the vault-based configuration.

Foundational behaviors for Magma configuration documents.

Magma.Config.Document for the general Magma system configuration.

A behavior for the different kinds of document types in Magma.

Represents a missing document that is referenced somewhere.

Provides an abstract representation of a Markdown document structured based on the Pandoc AST.

Recursive structure for the nested sections of a Magma.DocumentStruct.

Generic adapter-based Magma.Prompt execution.

Raised when a document type does not match the expected one.

Behaviour for types of matter that can be subject of a Magma.Concept and the Magma.Artefacts generated from these concepts.

Magma.Matter type behaviour implementation for Elixir modules.

Magma.Matter type behaviour implementation for the project Magma is used for.

A specialized Obsidian vault with directories for the Magma-specific documents.

Provides utilities to interact with predefined and custom base vaults.

Migration of Magma vaults to be compatible with newer versions.

Manages the versioning of the Magma vault.

Utility module with helper functions for creating the content of Magma documents.

Mix Tasks

A Mix task for selecting a prompt result as a draft version.

A Mix task for rendering a specified prompt, resolving all transclusions, and copying the result to the clipboard.

A Mix task for executing prompts.

A Mix task for generating Magma artefact prompt documents and custom prompt documents.

A Mix task for regenerating artefact prompt documents.

A Mix task for generating the section documents of a text from its final table of contents.

A Mix task for generating the final text from a given preview document.

A Mix task for generating the concept and artefact prompt documents for a new text.

A Mix task for generating a new text type.

A Mix task for initializing the Magma vault directory.

Migrates the Magma vault to a newer Magma version

A Mix task for syncing the module documents in the Magma vault with the ones in the codebase.