OBSIDREL / DOCS

Documentation

Guides, tutorials and technical references for the Obsidrel ecosystem.

DocumentationExtend SourceImporter using the public API

Extend SourceImporter using the public API

Importer addons implement contracts under me.antzbr.obsidrel.api.importer. The Core's built-in registry lists available providers, but conversion behavior comes from separately installed addons.

Available public entry points

  • ObsidrelPlatform.sourceImporters() returns a SourceImporterRegistry.
  • SourceImporterRegistry.all() lists public provider descriptors.
  • SourceImporterRegistry.find(id) searches an importer by provider ID.
  • AddonContext.registerSourceImporter(SourceImporterProvider) registers your own provider and tracks its lifecycle.

Choose between consuming and extending

If you want to use an existing importer, install its addon and place jobs under SourceImporter/<provider>/. If you want to build another importer, implement the public provider contract and register it from a native addon.

Do not attempt to instantiate a private Core converter or directly modify generated manifests. Preserve source projects and report partial/unsupported conversions accurately.

Version compatibility

Confirm the addon's API level and Core minimum version in its descriptor, then test a small fixture and inspect the generated report. Import results are not guaranteed to preserve every mechanic of a third-party format.

Was this article helpful?Loading ratings…

Help us improve Obsidrel documentation. One vote per account and article. Discord AI feedback can also contribute when the answer cites this article.