README file from
GithubObsidian Notice Plugin
🌐 Overview
The Notice Plugin is a powerful tool for controlling notices within the Obsidian application. It is primarily used to automatically remove Debug startup time notices for community plugins.
🚀 Features
- Remove Startup Notices: The plugin removes notices on the DOM load after a specified delay.
- Settings Tab: The plugin adds a settings tab in the Obsidian settings view. More details can be found in the Settings section.
🎯 Usage
After installing and enabling the plugin via the configuration on the Obsidian app, the plugin can be configured through the settings tab. When the Obsidian workspace is ready, it will remove all notices after the delay specified.
⚙️ Settings
The settings for the NoticePlugin can be accessed and modified via the settings tab added by the plugin. The default settings can be found in src/settings/settings.
delayInSeconds: Accepts values between 0 and 60 (seconds). 0 is reserved to keep the notice persistent.
📜 Changelog
For a detailed list of changes, check out the CHANGELOG.
🛠️ Technologies Used
This project uses Typescript to provide type checking and documentation. The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
🎓 First Time Developing Plugins?
See the official sample repository on https://github.com/obsidianmd/obsidian-sample-plugin for more information.
📚 API Documentation
Note: The Obsidian API is still in early alpha and is subject to change at any time!
See https://github.com/obsidianmd/obsidian-api
📄 License
This project is licensed under the terms of the MIT license.