obsidian-plugin/4source_favorites-obsidian-plugin
1
0
Fork 0
mirror of https://github.com/4source/favorites-obsidian-plugin.git synced 2026-07-22 06:44:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
3 commits 1 branch 9 tags 268 KiB
TypeScript 93.5%
JavaScript 6.3%
CSS 0.2%
Find a file
4Source 1fb7d34caf Basic favorites list management for plugin and themes
2025-08-16 22:19:50 +02:00
.github Initial renaming an cleanup 2025-08-16 21:18:49 +02:00
src Basic favorites list management for plugin and themes 2025-08-16 22:19:50 +02:00
test Initial commit 2025-08-12 22:56:59 +02:00
.eslintignore Initial commit 2025-08-12 22:56:59 +02:00
.eslintrc Initial commit 2025-08-12 22:56:59 +02:00
.eslintrc.dev Initial commit 2025-08-12 22:56:59 +02:00
.eslintrc.release Initial commit 2025-08-12 22:56:59 +02:00
.gitignore Initial commit 2025-08-12 22:56:59 +02:00
.npmrc Initial commit 2025-08-12 22:56:59 +02:00
esbuild.config.mjs Initial commit 2025-08-12 22:56:59 +02:00
jest.config.js Initial commit 2025-08-12 22:56:59 +02:00
LICENSE Initial commit 2025-08-12 22:56:59 +02:00
manifest.json Basic favorites list management for plugin and themes 2025-08-16 22:19:50 +02:00
package-lock.json Initial renaming an cleanup 2025-08-16 21:18:49 +02:00
package.json Initial renaming an cleanup 2025-08-16 21:18:49 +02:00
README.md Initial commit 2025-08-12 22:56:59 +02:00
tsconfig.json Initial commit 2025-08-12 22:56:59 +02:00
version-change.mjs Initial commit 2025-08-12 22:56:59 +02:00
versions.json Initial commit 2025-08-12 22:56:59 +02:00

README.md

This is a template repository

This is a template repository for Obsidian plugins.

Features

  • Linting Setup
  • Testing Setup with Jest
  • Auto Version bump
  • Auto Version update

Getting started

  • 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.

Need to change

package.json

  • name
  • description
  • author
  • license (optional)

manifest.json

  • id
  • name
  • description
  • author
  • authorUrl
  • fundingUrl
  • minAppVersion (optional)
  • isDesktopOnly (optional)

LICENSE (optional)

.github/workflows/cd.yml

versioning > Configure git

git config --global user.name "YOUR-USER"
git config --global user.email "YOUR-EMAIL"

bug_report.yaml

Plugin Version > Description: The Plugin where to look for the version

CONTRIBUTING.md

Need to add

New labels

  • major
  • minor
  • patch

Usage

  1. Create feature branch
  2. Make changes
  3. Push feature branch
  4. Create pull request
  5. Add desired label to pull request
  6. Merge pull request
  7. Publish draft release