obsidian-plugin/4source_open-editors-obsidian-plugin
1
0
Fork 0
mirror of https://github.com/4source/open-editors-obsidian-plugin.git synced 2026-07-22 11:40:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
1 commit 1 branch 4 tags 161 KiB
TypeScript 83.1%
JavaScript 12.3%
CSS 4.6%
Find a file
4Source 55530d4563
Initial commit
2024-12-02 12:01:31 +01:00
.github Initial commit 2024-12-02 12:01:31 +01:00
src Initial commit 2024-12-02 12:01:31 +01:00
test Initial commit 2024-12-02 12:01:31 +01:00
.eslintignore Initial commit 2024-12-02 12:01:31 +01:00
.eslintrc Initial commit 2024-12-02 12:01:31 +01:00
.gitignore Initial commit 2024-12-02 12:01:31 +01:00
.npmrc Initial commit 2024-12-02 12:01:31 +01:00
esbuild.config.mjs Initial commit 2024-12-02 12:01:31 +01:00
jest.config.js Initial commit 2024-12-02 12:01:31 +01:00
LICENSE Initial commit 2024-12-02 12:01:31 +01:00
manifest.json Initial commit 2024-12-02 12:01:31 +01:00
package-lock.json Initial commit 2024-12-02 12:01:31 +01:00
package.json Initial commit 2024-12-02 12:01:31 +01:00
README.md Initial commit 2024-12-02 12:01:31 +01:00
styles.css Initial commit 2024-12-02 12:01:31 +01:00
tsconfig.json Initial commit 2024-12-02 12:01:31 +01:00
version-change.mjs Initial commit 2024-12-02 12:01:31 +01:00
versions.json Initial commit 2024-12-02 12:01:31 +01: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"

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