Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Type definitions for the latest Obsidian API.
All API documentation is located in the file obsidian.d.ts
.
This will include types, properties, methods, and comments explaining what everything does.
For a full example on how to create Obsidian plugins, use the template at https://github.com/obsidianmd/obsidian-sample-plugin
manifest.json
id
the ID of your plugin.name
the display name of your plugin.author
the plugin author's name.version
the version of your plugin.minAppVersion
the minimum required Obsidian version for your plugin.description
the long description of your plugin.isDesktopOnly
whether your plugin uses NodeJS or Electron APIs.authorUrl
(optional) a URL to your own website.fundingUrl
(optional) a link for users to donation to show appreciation and support plugin development.main.js
require('obsidian')
require('fs')
or require('electron')
Plugin
App
, the global object that owns everything else. You can access this via this.app
inside your plugin. The App
interface provides accessors for the following interfaces.Vault
, the interface that lets you interact with files and folders in the vault.Workspace
, the interface that lets you interact with panes on the screen.MetadataCache
, the interface that contains cached metadata about each markdown file, including headings, links, embeds, tags, and blocks.Plugin
, you can:this.addRibbonIcon
.this.addStatusBarItem
.this.addCommand
.this.addSettingTab
.this.registerView
.this.loadData
and this.saveData
.For registering events from any event interfaces, such as App
and Workspace
, please use this.registerEvent
, which will automatically detach your event handler when your plugin unloads:
this.registerEvent(app.on('event-name', callback));
If you register DOM events for elements that persist on the page after your plugin unloads, such as window
or document
events, please use this.registerDomEvent
:
this.registerDomEvent(element, 'click', callback);
If you use setInterval
, please use this.registerInterval
:
this.registerInterval(setInterval(callback, 1000));
FAQs
Type definitions for the latest Obsidian API (https://obsidian.md)
The npm package obsidian receives a total of 1,793 weekly downloads. As such, obsidian popularity was classified as popular.
We found that obsidian demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.