Skip to main content

Obsidian Plugin Developer Docs

Buy me a coffee Community GitHub Who am I?

Introduction
Getting started
User interface
Editor
Vault
Events
Testing
Publishing
Reference
- TypeScript API
- Manifest
Tutorials
Examples
Developer tools
Contribute to this site

Reference
TypeScript API
Functions
ready

ready

function ready(fn: () => any): void;

Parameters

Parameter	Description
`fn`

prepareSimpleSearch

Parameters

Docs

Create your first plugin

Resources

Community
Create Your Own Obsidian Plugin
Obsidian API

More

GitHub