You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
##Obsidian Sample Plugin
1
+
# Obsidian Sample Plugin
2
2
3
3
This is a sample plugin for Obsidian (https://obsidian.md).
4
4
@@ -15,7 +15,7 @@ This sample plugin demonstrates some of the basic functionality the plugin API c
15
15
- Registers a global click event and output 'click' to the console.
16
16
- Registers a global interval which logs 'setInterval' to the console.
17
17
18
-
###First time developing plugins?
18
+
## First time developing plugins?
19
19
20
20
Quick starting guide for new plugin devs:
21
21
@@ -29,7 +29,7 @@ Quick starting guide for new plugin devs:
29
29
- Enable plugin in settings window.
30
30
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
31
31
32
-
###Releasing new releases
32
+
## Releasing new releases
33
33
34
34
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
35
35
- 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.
@@ -40,24 +40,24 @@ Quick starting guide for new plugin devs:
40
40
> 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`.
41
41
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
42
42
43
-
###Adding your plugin to the community plugin list
43
+
## Adding your plugin to the community plugin list
- Make sure you have a `README.md` file in the root of your repo.
48
48
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
49
49
50
-
###How to use
50
+
## How to use
51
51
52
52
- Clone this repo.
53
53
-`npm i` or `yarn` to install dependencies
54
54
-`npm run dev` to start compilation in watch mode.
55
55
56
-
###Manually installing the plugin
56
+
## Manually installing the plugin
57
57
58
58
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
59
59
60
-
###Improve code quality with eslint (optional)
60
+
## Improve code quality with eslint (optional)
61
61
-[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.
62
62
- To use eslint with this project, make sure to install eslint from terminal:
63
63
-`npm install -g eslint`
@@ -68,6 +68,6 @@ Quick starting guide for new plugin devs:
0 commit comments