mirror of
https://github.com/qf3l3k/obsidian-data-fetcher.git
synced 2026-07-22 05:43:10 +00:00
Update README.md
This commit is contained in:
qf3l3k
GitHub
parent
f289982680
commit
b2c0dfb528
1 changed files with 103 additions and 74 deletions
177
README.md
177
README.md
|
|
@ -1,94 +1,123 @@
|
|||
# Obsidian Sample Plugin
|
||||
# Obsidian Data Fetcher
|
||||
|
||||
This is a sample plugin for Obsidian (https://obsidian.md).
|
||||
A plugin for [Obsidian](https://obsidian.md) that allows users to fetch data from multiple sources (REST APIs, GraphQL, gRPC, RPC) and insert the results into notes.
|
||||
|
||||
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.
|
||||
- Support for multiple data sources:
|
||||
- REST APIs
|
||||
- GraphQL endpoints
|
||||
- gRPC services (via REST proxies)
|
||||
- RPC services
|
||||
- Two modes of operation:
|
||||
- Directly define queries within notes
|
||||
- Predefine endpoints in settings and reference them in notes
|
||||
- Automatic caching of query results to reduce redundant requests
|
||||
- Cache expiration settings
|
||||
- Manual refresh capabilities
|
||||
- Customizable headers for authentication
|
||||
|
||||
## First time developing plugins?
|
||||
## Installation
|
||||
|
||||
Quick starting guide for new plugin devs:
|
||||
### From Obsidian Community Plugins
|
||||
|
||||
- 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.
|
||||
1. Open Obsidian Settings
|
||||
2. Go to Community Plugins
|
||||
3. Search for "Data Fetcher"
|
||||
4. Click Install, then Enable
|
||||
|
||||
## Releasing new releases
|
||||
### Manual Installation
|
||||
|
||||
- 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. Download the latest release from the [releases page](https://github.com/qf3l3k/obsidian-api-fetcher/releases)
|
||||
2. Extract the zip file into your Obsidian vault's `.obsidian/plugins` folder
|
||||
3. Enable the plugin in Obsidian settings
|
||||
|
||||
> 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`
|
||||
## Usage
|
||||
|
||||
## Adding your plugin to the community plugin list
|
||||
### Method 1: Direct Query Definition
|
||||
|
||||
- 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.
|
||||
Create a code block with the language set to `data-query` and define your query in JSON format:
|
||||
|
||||
## How to use
|
||||
|
||||
- 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.
|
||||
|
||||
## 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
|
||||
```
|
||||
```data-query
|
||||
{
|
||||
"fundingUrl": "https://buymeacoffee.com"
|
||||
"type": "rest",
|
||||
"url": "https://api.example.com/data",
|
||||
"method": "GET",
|
||||
"headers": {
|
||||
"Authorization": "Bearer your-token"
|
||||
}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
If you have multiple URLs, you can also do:
|
||||
### Method 2: Using Aliases
|
||||
|
||||
```json
|
||||
{
|
||||
"fundingUrl": {
|
||||
"Buy Me a Coffee": "https://buymeacoffee.com",
|
||||
"GitHub Sponsor": "https://github.com/sponsors",
|
||||
"Patreon": "https://www.patreon.com/"
|
||||
}
|
||||
}
|
||||
1. First, define an endpoint alias in the plugin settings
|
||||
2. Then reference it in your notes:
|
||||
|
||||
```
|
||||
```data-query
|
||||
@my-api-alias
|
||||
body: {"id": 123}
|
||||
```
|
||||
```
|
||||
|
||||
## API Documentation
|
||||
## Configuration
|
||||
|
||||
See https://github.com/obsidianmd/obsidian-api
|
||||
Go to Settings > Data Fetcher to configure:
|
||||
|
||||
- Cache duration
|
||||
- Pre-defined endpoint aliases
|
||||
- Default headers
|
||||
|
||||
## Examples
|
||||
|
||||
### REST API Example
|
||||
|
||||
```
|
||||
```data-query
|
||||
{
|
||||
"type": "rest",
|
||||
"url": "https://jsonplaceholder.typicode.com/posts/1",
|
||||
"method": "GET"
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
### GraphQL Example
|
||||
|
||||
```
|
||||
```data-query
|
||||
{
|
||||
"type": "graphql",
|
||||
"url": "https://api.spacex.land/graphql",
|
||||
"query": "{ launchesPast(limit: 5) { mission_name launch_date_local } }",
|
||||
"variables": {}
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
### Using Aliases
|
||||
|
||||
```
|
||||
```data-query
|
||||
@github-api
|
||||
query: query { viewer { repositories(first: 5) { nodes { name } } } }
|
||||
```
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
If you encounter any issues or have feature requests, please file them on the [GitHub issues page](https://github.com/qf3l3k/obsidian-api-fetcher/issues).
|
||||
|
||||
|
||||
[](https://buymeacoffee.com/qf3l3k)
|
||||
|
||||
<a href="https://www.buymeacoffee.com/qf3l3k" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style=" height: 40px !important;width: 217px !important;" ></a>
|
||||
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
|
|
|||
Loading…
Reference in a new issue