Merge pull request #3 from shmolf/version-1

Version 1

README.md

@@ -1,96 +1,15 @@
-# Obsidian Sample Plugin
+# Obsidian Editor Background Plugin
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+This is in early development, and likly won't see many changes unless I receive issues or PRs.
+Of course, if I desire something new, I'll add it. But from what I've heard from similar editor communities,
+this isn't a sought-after feature, so I don't really expect anyone else other than myself to use this.
 
-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.
+## Example 1
+![Example 1](screenshots/Example1.jpg)
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+This example uses no bluriness and default input area contrast.
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Changes the default font color to red using `styles.css`.
-- 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.
+## Example 2
+![Example 2](screenshots/Example2.jpg)
 
-## 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`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
-
-## Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- 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.
-
-## How to use
-
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- 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`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- 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
+This example uses high degree of bluriness, with no input area contrast.

example-markdown.md

@@ -0,0 +1,19 @@
+# This is an example Header Lvl 1
+## This is an example Header Lvl 2
+### This is an example Header Lvl 3
+#### This is an example Header Lvl 4
+##### This is an example Header Lvl 5
+
+```js
+$(() => {
+  $editor = $('#markdown-input');
+  $mdView = $('#markdown-output');
+  initCodeMirror();
+  initMarkdownIt();
+  $mdView.on('input', () => renderMarkdown());
+});
+```
+
+1. List item 1
+2. Item 2
+3. Item 3

src/PluginSettingsTab.ts

@@ -21,11 +21,13 @@ export class UrlSettingsTab extends PluginSettingTab {
     containerEl.empty();
 
     const instructions = containerEl.createEl('div');
-    instructions.createEl('p', { text: 'To disable the background, clear the URL for the background.' });
+    instructions.createEl('p', { text: 'The URL needs to be a remote resource, and does not yet (or at least not on my machine) support local files.' });
+    instructions.createEl('p', { text: 'Some of the other settings, like opacity, bluriness, and input contrast, are helpers to tweak your experience.' });
+    instructions.createEl('a', { href: 'https://github.com/shmolf/obsidian-editor-background/issues', text: 'Submit an issue' });
 
     new Setting(containerEl)
       .setName('Background Image URL')
-      .setDesc('URL (local or remote) for the background image.')
+      .setDesc('URL for the background image to load.')
       .addText((text) =>
         text
           .setPlaceholder('https://example.com/image.png')
@@ -52,7 +54,7 @@ export class UrlSettingsTab extends PluginSettingTab {
 
     new Setting(containerEl)
       .setName('Image Bluriness')
-      .setDesc('Increasing the can make the text more legible.')
+      .setDesc('Increasing the blur can help make the text more legible.')
       .addDropdown((dropdown) => {
           dropdown
               .addOption(blurLevels.off, 'Off')
@@ -67,7 +69,7 @@ export class UrlSettingsTab extends PluginSettingTab {
 
     new Setting(containerEl)
       .setName('Input Area Contrast Background')
-      .setDesc('This adds a translucent background for the input area, to make it clear where you can type.')
+      .setDesc('This adds a translucent background for the input area, to help improve legibility.')
       .addToggle((toggle) => {
         toggle.setTooltip('Enable to increase the contrast of the input area.')
               .setValue(this.plugin.settings.inputContrast)