generated from obsidianmd/obsidian-sample-plugin
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PubScale is a lightweight plugin that allows you to seamlessly insert, update, and delete markdown text in Obsidian into PlanetScale tables.
- Loading branch information
Showing
7 changed files
with
1,574 additions
and
199 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,30 @@ | ||
| # Obsidian Sample Plugin | ||
| # PubScale | ||
| PubScale is a lightweight plugin that allows you to seamlessly insert, update, and delete markdown text in Obsidian into PlanetScale tables. You can leverage PlanetScale as a content management store and Obsidian as your preferred content editor. | ||
|
|
||
| This is a sample plugin for Obsidian (https://obsidian.md). | ||
| ## Features | ||
| - Manage and synchronize your markdown files edited in Obsidian with PlanetScale | ||
| - Specialized integration with PlanetScale for easy setup | ||
| - Full control over which notes are synced with PlanetScale | ||
|
|
||
| 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. | ||
| ## Setup | ||
| To get started with PubScale, follow these simple steps: | ||
|
|
||
| **Note:** The Obsidian API is still in early alpha and is subject to change at any time! | ||
| 1. Install the PubScale plugin through the Obsidian Community Plugins. | ||
| 2. Configure the plugin by adding your PlanetScale credentials and choosing the desired database and table. | ||
| 3. Open the note you want to sync with PlanetScale. | ||
|
|
||
| This sample plugin demonstrates some of the basic functionality the plugin API can do. | ||
| - Changes the default font color to red using `styles.css`. | ||
| - 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. | ||
| ## Usage | ||
| ### Insert a note | ||
| Access the Command Palette and select `PubScale: Insert`. This will insert the active note into your PlanetScale table. | ||
|
|
||
| ## First time developing plugins? | ||
| ### Update a note | ||
| Access the Command Palette and select `PubScale: Update`. This will update the active note in your PlanetScale table. Note that PubScale identify notes by their title. If you change the title of a note, PubScale will insert a new note into your PlanetScale table. | ||
|
|
||
| Quick starting guide for new plugin devs: | ||
| ### Delete a note | ||
| Access the Command Palette and select `PubScale: Delete`. This will delete the active note from your PlanetScale table. | ||
|
|
||
| - 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. | ||
| ## Support | ||
| For any issues or feature requests, please create an issue in the repository. | ||
|
|
||
| ## Releasing new releases | ||
|
|
||
| - 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. | ||
|
|
||
| > 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` | ||
| ## Adding your plugin to the community plugin list | ||
|
|
||
| - Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md | ||
| - 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. | ||
|
|
||
| ## How to use | ||
|
|
||
| - Clone this repo. | ||
| - `npm i` or `yarn` to install dependencies | ||
| - `npm run dev` to start compilation in watch mode. | ||
|
|
||
| ## Manually installing the plugin | ||
|
|
||
| - Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. | ||
|
|
||
| ## 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\` | ||
|
|
||
| ## Funding URL | ||
|
|
||
| You can include funding URLs where people who use your plugin can financially support it. | ||
|
|
||
| The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file: | ||
|
|
||
| ```json | ||
| { | ||
| "fundingUrl": "https://buymeacoffee.com" | ||
| } | ||
| ``` | ||
|
|
||
| If you have multiple URLs, you can also do: | ||
|
|
||
| ```json | ||
| { | ||
| "fundingUrl": { | ||
| "Buy Me a Coffee": "https://buymeacoffee.com", | ||
| "GitHub Sponsor": "https://github.com/sponsors", | ||
| "Patreon": "https://www.patreon.com/" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## API Documentation | ||
|
|
||
| See https://github.com/obsidianmd/obsidian-api | ||
| ## License | ||
| This project is licensed under the MIT License. |
Oops, something went wrong.