obsidian-plugin/wakywayne_obsidian-hotstrings
1
0
Fork 0
mirror of https://github.com/wakywayne/obsidian-hotstrings.git synced 2026-07-22 05:35:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Manifest File

Browse source
This commit is contained in:
wakywayne80@gmail.com 2025-01-09 20:54:12 -05:00
parent 30d76b4db3
commit 3619aaf839
4 changed files with 54 additions and 236 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

123
README.md
View file

@ -1,94 +1,77 @@
# Obsidian Sample Plugin
# Obsidian Hotstrings Plugin
This is a sample plugin for Obsidian (https://obsidian.md).
A plugin for [Obsidian](https://obsidian.md) that allows you to create custom text expansions (hotstrings) that automatically expand as you type.
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.
## Features
This sample plugin demonstrates some of the basic functionality the plugin API can do.
- Adds a ribbon icon, which shows a Notice when clicked.
- Adds a command "Open Sample Modal" which opens a Modal.
- Adds a plugin setting tab to the settings page.
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
- Create custom text expansions that trigger automatically while typing
- Supports both simple and complex text replacements
- Easy to configure through the plugin settings
- Works in any note or editor within Obsidian
- Hotstrings can be reloaded without restarting Obsidian
## First time developing plugins?
## Installation
Quick starting guide for new plugin devs:
1. Open Obsidian Settings
2. Go to Community Plugins and disable Safe Mode
3. Click Browse and search for "Hotstrings"
4. Install the plugin and enable it
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
## Usage
## Releasing new releases
### Creating Hotstrings
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
- Publish the release.
1. Open Obsidian Settings
2. Navigate to the Hotstrings plugin settings
3. Add new hotstrings in the format:
- Trigger: The text you type
- Expansion: The text it expands to
> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
Example:
LOL~.~{Laugh Out Loud}
## Adding your plugin to the community plugin list
### Using Hotstrings
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo.
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
Simply type your trigger text anywhere in Obsidian. The plugin will automatically replace it with your defined expansion.
## How to use
### Reloading Hotstrings
- Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
If you make changes to your hotstrings, you can reload them using the command palette:
## Manually installing the plugin
1. Press `Ctrl/Cmd + P` to open the command palette
2. Search for "Reload Hotstrings"
3. Select the command to reload your changes
_Alternatively you can add a hotkey by clicking the plus button in the hotkey settings_
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Examples
## Improve code quality with eslint (optional)
- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
- To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint`
- To use eslint to analyze this project use this command:
- `eslint main.ts`
- eslint will then create a report with suggestions for code improvement by file and line number.
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
- `eslint .\src\`
Here are some useful hotstring examples:
## Funding URL
- `:sig` → Your signature
- `:date` → Current date
- `:addr` → Your address
- `:mail` → Your email address
You can include funding URLs where people who use your plugin can financially support it.
## Tips
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
- Use the quick add plugin to easily add hotstrings to the hotstring file [git-repo](https://github.com/chhoumann/quickadd)
- Hotstrings are case-sensitive by default
- Triggers must be unique
- Use the reload command after adding new hotstrings
```json
{
"fundingUrl": "https://buymeacoffee.com"
}
```
## Troubleshooting
If you have multiple URLs, you can also do:
If hotstrings aren't working:
```json
{
"fundingUrl": {
"Buy Me a Coffee": "https://buymeacoffee.com",
"GitHub Sponsor": "https://github.com/sponsors",
"Patreon": "https://www.patreon.com/"
}
}
```
1. Check if the plugin is enabled under Community Plugins
2. Try reloading the hotstrings using the command palette
3. Ensure there are no conflicts with your hotstrings
4. Restart Obsidian if issues persist
## API Documentation
## Support
See https://github.com/obsidianmd/obsidian-api
If you encounter any issues or have suggestions:
- Open an issue on the GitHub repository
- Include steps to reproduce the problem
- Provide your Obsidian version and operating system

2
manifest.json
View file

@ -3,7 +3,7 @@
"name": "Obsidian Hot Strings",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Allows you to set custom hot strings that get converted to text once typed. In less then 15 seconds you can make a custom string that will be converted into whatever text you want. All strings are managed in a hotstrings file. After adding a new hotstring just run the reload command or use a hotkey config in the plugin by clicking th + icon.",
"description": "Allows you to set custom hot strings that get converted to text once typed. In less then 15 seconds you can make a custom string that will be converted into whatever text you want. All strings are managed in a hotstrings file. After adding a new hotstring just run the reload command or use a hotkey config in the plugin by clicking the + icon.",
"author": "wakywayne",
"authorUrl": "https://github.com/wakywayne/wakywayne/blob/main/README.md",
"fundingUrl": "",

11
manifest.txt
View file

@ -1,11 +0,0 @@
{
"id": "obsidian-hot-strings",
"name": "Hot Strings",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Allows you to set custom hot strings that get converted to text once typed. No hotkeys neccassary... in less then 15 seconds you can make a custom string that will be converted into whatever text you want",
"author": "wakywayne",
"authorUrl": "https://github.com/wakywayne/wakywayne/blob/main/README.md",
"fundingUrl": "",
"isDesktopOnly": false
}

154
old_main.ts
View file

@ -1,154 +0,0 @@
import {
App,
Editor,
MarkdownView,
Modal,
Notice,
Plugin,
PluginSettingTab,
Setting,
} from "obsidian";
// Remember to rename these classes and interfaces!
interface MyPluginSettings {
mySetting: string;
}
const DEFAULT_SETTINGS: MyPluginSettings = {
mySetting: "default",
};
export default class MyPlugin extends Plugin {
settings: MyPluginSettings;
async onload() {
await this.loadSettings();
// This creates an icon in the left ribbon.
const ribbonIconEl = this.addRibbonIcon(
"dice",
"Sample Plugin",
(evt: MouseEvent) => {
// Called when the user clicks the icon.
new Notice("This is a notice!");
},
);
// Perform additional things with the ribbon
ribbonIconEl.addClass("my-plugin-ribbon-class");
// This adds a status bar item to the bottom of the app. Does not work on mobile apps.
const statusBarItemEl = this.addStatusBarItem();
statusBarItemEl.setText("Status Bar Text");
// This adds a simple command that can be triggered anywhere
this.addCommand({
id: "open-sample-modal-simple",
name: "Open sample modal (simple)",
callback: () => {
new SampleModal(this.app).open();
},
});
// This adds an editor command that can perform some operation on the current editor instance
this.addCommand({
id: "sample-editor-command",
name: "Sample editor command",
editorCallback: (editor: Editor, view: MarkdownView) => {
console.log(editor.getSelection());
editor.replaceSelection("Sample Editor Command");
},
});
// This adds a complex command that can check whether the current state of the app allows execution of the command
this.addCommand({
id: "open-sample-modal-complex",
name: "Open sample modal (complex)",
checkCallback: (checking: boolean) => {
// Conditions to check
const markdownView =
this.app.workspace.getActiveViewOfType(MarkdownView);
if (markdownView) {
// If checking is true, we're simply "checking" if the command can be run.
// If checking is false, then we want to actually perform the operation.
if (!checking) {
new SampleModal(this.app).open();
}
// This command will only show up in Command Palette when the check function returns true
return true;
}
},
});
// This adds a settings tab so the user can configure various aspects of the plugin
this.addSettingTab(new SampleSettingTab(this.app, this));
// If the plugin hooks up any global DOM events (on parts of the app that doesn't belong to this plugin)
// Using this function will automatically remove the event listener when this plugin is disabled.
this.registerDomEvent(document, "click", (evt: MouseEvent) => {
console.log("click", evt);
});
// When registering intervals, this function will automatically clear the interval when the plugin is disabled.
this.registerInterval(
window.setInterval(() => console.log("setInterval"), 5 * 60 * 1000),
);
}
onunload() {}
async loadSettings() {
this.settings = Object.assign(
{},
DEFAULT_SETTINGS,
await this.loadData(),
);
}
async saveSettings() {
await this.saveData(this.settings);
}
}
class SampleModal extends Modal {
constructor(app: App) {
super(app);
}
onOpen() {
const { contentEl } = this;
contentEl.setText("Woah!");
}
onClose() {
const { contentEl } = this;
contentEl.empty();
}
}
class SampleSettingTab extends PluginSettingTab {
plugin: MyPlugin;
constructor(app: App, plugin: MyPlugin) {
super(app, plugin);
this.plugin = plugin;
}
display(): void {
const { containerEl } = this;
containerEl.empty();
new Setting(containerEl)
.setName("Setting #1")
.setDesc("It's a secret")
.addText((text) =>
text
.setPlaceholder("Enter your secret")
.setValue(this.plugin.settings.mySetting)
.onChange(async (value) => {
this.plugin.settings.mySetting = value;
await this.plugin.saveSettings();
}),
);
}
}