tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
61 Commits 1 Branch 1 Tag 45 MiB
TypeScript 68.5%
JavaScript 28.6%
CSS 2.9%
Go to file Use this template
Brady Kelly b01c4c6278 Initial changes 2024-03-16 10:24:05 +02:00
.editorconfig use LF instead of CRLF (#28) 2022-04-15 14:13:31 -04:00
.eslintignore fix .eslintignore (#48) 2023-01-19 10:06:51 -05:00
.eslintrc add version bump script (#10) 2022-01-22 16:13:50 -05:00
.gitignore Update .gitignore (#25) 2022-01-28 10:34:53 -05:00
.npmrc Initial changes 2024-03-16 10:24:05 +02:00
GUIDE.md Initial changes 2024-03-16 10:24:05 +02:00
README.md Initial changes 2024-03-16 10:24:05 +02:00
esbuild.config.mjs Upgrade esbuild to v0.17.x (#47) 2023-01-25 13:49:50 -05:00
main.ts Adapt to plugin guidelines (#65) 2023-07-17 12:36:25 -04:00
manifest.json Initial changes 2024-03-16 10:24:05 +02:00
package.json Initial changes 2024-03-16 10:24:05 +02:00
pnpm-lock.yaml Initial changes 2024-03-16 10:24:05 +02:00
styles.css Update sample css file. 2022-08-09 13:39:02 -04:00
tsconfig.json Upgrade dependencies, add strictNullChecks. 2022-06-24 15:41:39 -04:00
version-bump.mjs add version bump script (#10) 2022-01-22 16:13:50 -05:00
versions.json Update for 0.15 2022-08-09 13:38:50 -04:00

README.md

Obsidian Plugin Template

This template repo is intended to back most of my Obsidian plugins. It is a fork of Obsidian Sample Plugin.

Excerpts from the original README.md:

This is a sample plugin for Obsidian (https://obsidian.md).

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.

Changes by me:

  1. Getting started guide from original README.md is now in GUIDE.md
  2. Replaced npm with pnpm.
  3. Turned hoisting off for all packages. Experimental and may have to allow for some packages later.
  4. Personalized manifest.json.