Skip to content

Commit f85d2b7

Browse files
authored
Fix README headings (#29)
1 parent f690c04 commit f85d2b7

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Obsidian Sample Plugin
1+
# Obsidian Sample Plugin
22

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

@@ -15,7 +15,7 @@ This sample plugin demonstrates some of the basic functionality the plugin API c
1515
- Registers a global click event and output 'click' to the console.
1616
- Registers a global interval which logs 'setInterval' to the console.
1717

18-
### First time developing plugins?
18+
## First time developing plugins?
1919

2020
Quick starting guide for new plugin devs:
2121

@@ -29,7 +29,7 @@ Quick starting guide for new plugin devs:
2929
- Enable plugin in settings window.
3030
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
3131

32-
### Releasing new releases
32+
## Releasing new releases
3333

3434
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
3535
- 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:
4040
> 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`.
4141
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
4242
43-
### Adding your plugin to the community plugin list
43+
## Adding your plugin to the community plugin list
4444

4545
- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
4646
- Publish an initial version.
4747
- Make sure you have a `README.md` file in the root of your repo.
4848
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
4949

50-
### How to use
50+
## How to use
5151

5252
- Clone this repo.
5353
- `npm i` or `yarn` to install dependencies
5454
- `npm run dev` to start compilation in watch mode.
5555

56-
### Manually installing the plugin
56+
## Manually installing the plugin
5757

5858
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
5959

60-
### Improve code quality with eslint (optional)
60+
## Improve code quality with eslint (optional)
6161
- [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.
6262
- To use eslint with this project, make sure to install eslint from terminal:
6363
- `npm install -g eslint`
@@ -68,6 +68,6 @@ Quick starting guide for new plugin devs:
6868
- `eslint .\src\`
6969

7070

71-
### API Documentation
71+
## API Documentation
7272

7373
See https://github.com/obsidianmd/obsidian-api

0 commit comments

Comments
 (0)