Format, rebrand and add license file

.eslintrc

@@ -2,9 +2,7 @@
 	"root": true,
 	"parser": "@typescript-eslint/parser",
 	"env": { "node": true },
-    "plugins": [
+	"plugins": ["@typescript-eslint"],
-      "@typescript-eslint"
-    ],
 	"extends": [
 		"eslint:recommended",
 		"plugin:@typescript-eslint/eslint-recommended",
@@ -20,4 +18,4 @@
 		"no-prototype-builtins": "off",
 		"@typescript-eslint/no-empty-function": "off"
 	}
-  }
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mylloon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,25 +1,13 @@
-# Obsidian Sample Plugin
+# SVG-Obsidian
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+Plugin Obsidian pour pouvoir voir les SVG sans se soucier du thème clair/sombre.
 
-This project uses Typescript to provide type checking and documentation.
+Utile principalement pour les exports des dessins excalidraw.
-The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+<!-- ## First time developing plugins?
-
-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.
-
-## First time developing plugins?
 
 Quick starting guide for new plugin devs:
 
-- 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`.
@@ -44,7 +32,7 @@ Quick starting guide for new plugin devs:
 -   Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
 -   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.
+-   Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin. -->
 
 ## How to use
 
@@ -58,6 +46,7 @@ Quick starting guide for new plugin devs:
 -   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`
@@ -67,30 +56,6 @@ Quick starting guide for new plugin devs:
 -   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
-{
-    "fundingUrl": "https://buymeacoffee.com"
-}
-```
-
-If you have multiple URLs, you can also do:
-
-```json
-{
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
-}
-```
-
 ## API Documentation
 
 See https://github.com/obsidianmd/obsidian-api

esbuild.config.mjs

@@ -2,14 +2,13 @@ import esbuild from "esbuild";
 import process from "process";
 import builtins from "builtin-modules";
 
-const banner =
+const banner = `/*
-`/*
 THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
 if you want to view the source, please visit the github repository of this plugin
 */
 `;
 
-const prod = (process.argv[2] === "production");
+const prod = process.argv[2] === "production";
 
 const context = await esbuild.context({
 	banner: {
@@ -31,7 +30,8 @@ const context = await esbuild.context({
 		"@lezer/common",
 		"@lezer/highlight",
 		"@lezer/lr",
-		...builtins],
+		...builtins,
+	],
 	format: "cjs",
 	target: "es2018",
 	logLevel: "info",

manifest.json

@@ -1,11 +1,11 @@
 {
-	"id": "sample-plugin",
+	"id": "svg-obsidian",
-	"name": "Sample Plugin",
+	"name": "SVG Obsidian",
 	"version": "1.0.0",
 	"minAppVersion": "0.15.0",
-	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
+	"description": "View SVGs without worrying about the light/dark theme.",
-	"author": "Obsidian",
+	"author": "Mylloon",
-	"authorUrl": "https://obsidian.md",
+	"authorUrl": "https://mylloon.fr",
-	"fundingUrl": "https://obsidian.md/pricing",
+	"fundingUrl": "https://github.com/sponsors/Mylloon",
 	"isDesktopOnly": false
 }

package.json

@@ -1,15 +1,19 @@
 {
-	"name": "obsidian-sample-plugin",
+	"name": "svg-obsidian",
 	"version": "1.0.0",
-	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+	"description": "View SVGs without worrying about the light/dark theme.",
 	"main": "main.js",
 	"scripts": {
 		"dev": "node esbuild.config.mjs",
 		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
 		"version": "node version-bump.mjs && git add manifest.json versions.json"
 	},
-	"keywords": [],
+	"keywords": [
-	"author": "",
+		"obsidian",
+		"plugin",
+		"svg"
+	],
+	"author": "Mylloon",
 	"license": "MIT",
 	"devDependencies": {
 		"@types/node": "^16.11.6",

tsconfig.json

@@ -11,14 +11,7 @@
 		"importHelpers": true,
 		"isolatedModules": true,
 		"strictNullChecks": true,
-    "lib": [
+		"lib": ["DOM", "ES5", "ES6", "ES7"]
-      "DOM",
-      "ES5",
-      "ES6",
-      "ES7"
-    ]
 	},
-  "include": [
+	"include": ["**/*.ts"]
-    "**/*.ts"
-  ]
 }