No description
Find a file
Forketyfork 52a3a2a0a4
v0.4.0
2025-05-23 17:57:07 +02:00
.github/workflows Added test coverage 2025-05-22 09:49:59 +02:00
__mocks__ Added test coverage 2025-05-22 09:49:59 +02:00
__tests__ Formatting, removing redundant logging 2025-05-23 17:51:13 +02:00
images Updated plugin documentation 2025-05-21 08:03:31 +02:00
.editorconfig Initial version 2025-04-14 10:53:12 +02:00
.eslintignore Initial version 2025-04-14 10:53:12 +02:00
.eslintrc Initial version 2025-04-14 10:53:12 +02:00
.gitignore CSS minification, build script improvements. Fixes #3 2025-04-15 09:32:09 +02:00
.npmrc Initial version 2025-04-14 10:53:12 +02:00
.prettierignore 0.2.0: Configure note template 2025-05-02 07:53:25 +02:00
.prettierrc 0.2.0: Configure note template 2025-05-02 07:53:25 +02:00
AGENTS.md Added a symbolic link to AGENTS.md 2025-05-21 07:20:12 +02:00
CLAUDE.md Fixing date issues in tests 2025-05-22 10:09:38 +02:00
esbuild.config.mjs Added test coverage 2025-05-22 09:49:59 +02:00
jest.config.js Added test coverage 2025-05-22 09:49:59 +02:00
LICENSE License 2025-04-14 12:07:27 +02:00
main.ts Improvements to the template parsing code 2025-05-23 17:54:33 +02:00
manifest.json v0.4.0 2025-05-23 17:57:07 +02:00
package.json v0.4.0 2025-05-23 17:57:07 +02:00
README.md Parse fields from template 2025-05-22 23:10:20 +02:00
styles.src.css Release 0.2.2. Cleanup of review issues. 2025-05-02 21:12:54 +02:00
tsconfig.json Added test coverage 2025-05-22 09:49:59 +02:00
version-bump.mjs 0.2.0: Configure note template 2025-05-02 07:53:25 +02:00
versions.json v0.4.0 2025-05-23 17:57:07 +02:00
yarn.lock Added test coverage 2025-05-22 09:49:59 +02:00

YouTrack Fetcher

Build status

This Obsidian plugin allows you to quickly fetch YouTrack issues and create notes from them in your Obsidian vault.

Features

  • Fetch YouTrack issues by ID and create structured notes
  • Easy access via keyboard shortcut
  • API token authentication support
  • Configurable folder for storing issue notes
  • Configurable note template
  • Use ${field} placeholders in templates to insert values from fetched fields
  • Fields to fetch are parsed from your template automatically

Installation

From Obsidian Community Plugins

  1. Open Obsidian
  2. Go to Settings > Community plugins
  3. Disable Safe mode if necessary
  4. Click Browse and search for "YouTrack Fetcher"
  5. Install the plugin
  6. Enable the plugin after installation

Manual Installation

  1. Download the latest release from the GitHub repository
  2. Extract the ZIP file into your Obsidian vault's .obsidian/plugins/ folder
  3. Enable the plugin in Obsidian settings

Usage

  1. Set up your YouTrack instance URL in plugin settings
  2. Configure API token if required for your YouTrack instance plugin settings
  3. Use the keyboard shortcut or click the clipboard icon in the ribbon fetch issue window
  4. Enter the issue ID
  5. Click "Fetch Issue" to create a note based on the issue data fetched issue

Note Format

The plugin creates notes with the following format. As an alternative, specify your own template in the plugin settings.

# ${id}: ${title}

URL: ${url}

## Description

${description}

Any field referenced in the template can be used as a placeholder with ${field}.

The issue summary can also be used as a ${title} placeholder.

Requirements

  • Obsidian v0.15.0 or higher
  • Access to a YouTrack instance (cloud or self-hosted)

Troubleshooting

  • If you have trouble authenticating, make sure your API token has proper permissions
  • For self-hosted instances, check that the REST API is accessible

Development

Run the development build with change watch:

yarn dev:watch

Run the TypeScript type check:

yarn typecheck

Run the tests:

yarn test

Run the tests in watch mode:

yarn test:watch

Run the production build (includes tests, type checking, and formatting):

yarn build

Bump the version in package.json and manifest.json and add a tag:

yarn version

Publish a new release from the added tag:

git push --tags

License

This plugin is licensed under the MIT License.