x/swarnam-obsidian
1
0
Fork 0
mirror of https://github.com/runofthemillgeek/swarnam-obsidian.git synced 2024-11-16 07:20:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix README headings (#29)

Browse Source
This commit is contained in:
Henré Botha 2022-05-07 17:15:23 +02:00 committed by GitHub
parent f690c04577
commit f85d2b74b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,4 +1,4 @@
## Obsidian Sample Plugin # Obsidian Sample Plugin
This is a sample plugin for Obsidian (https://obsidian.md). This is a sample plugin for Obsidian (https://obsidian.md).
@ -15,7 +15,7 @@ This sample plugin demonstrates some of the basic functionality the plugin API c
- Registers a global click event and output 'click' to the console. - Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console. - Registers a global interval which logs 'setInterval' to the console.
### First time developing plugins? ## First time developing plugins?
Quick starting guide for new plugin devs: Quick starting guide for new plugin devs:
@ -29,7 +29,7 @@ Quick starting guide for new plugin devs:
- Enable plugin in settings window. - Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder. - For updates to the Obsidian API run `npm update` in the command line under your repo folder.
### Releasing new releases ## 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 `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. - 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:
> 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`. > 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` > 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 ## Adding your plugin to the community plugin list
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md - Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
- Publish an initial version. - Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo. - 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 ## How to use
- Clone this repo. - Clone this repo.
- `npm i` or `yarn` to install dependencies - `npm i` or `yarn` to install dependencies
- `npm run dev` to start compilation in watch mode. - `npm run dev` to start compilation in watch mode.
### Manually installing the plugin ## Manually installing the plugin
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. - Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
### Improve code quality with eslint (optional) ## 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. - [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: - To use eslint with this project, make sure to install eslint from terminal:
- `npm install -g eslint` - `npm install -g eslint`
@ -68,6 +68,6 @@ Quick starting guide for new plugin devs:
- `eslint .\src\` - `eslint .\src\`
### API Documentation ## API Documentation
See https://github.com/obsidianmd/obsidian-api See https://github.com/obsidianmd/obsidian-api