Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "How to add your plugin to the community plugin list" #637

Merged
merged 3 commits into from
Oct 25, 2023
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,21 @@ This note is based on the instructions of the [obsidian sample plugin readme](ht

1. Fork the [obsidian-releases](https://github.com/obsidianmd/obsidian-releases#community-plugins) repo and edit the `community-plugins.json` file. If you prefer to do it from GitHub's web interface, you can follow this instructions, but submit your changes as described in [[How to add content through GitHub]] or [[How to add your plugin to the community plugin list#Submitting your plugin]].
2. Add the information of your plugin at the end of the list (Don't forget to add a comma after the last plugin!). For your convenience you can copy this template and paste it at the end of the list:
```json
{
"id": ""
"name": "",
"author": "",
"description": ""
"repo": "<github username>/<repository>",
"branch": "master"
}
```
```json
{
"id": "",
"name": "",
"author": "",
"description": "",
"repo": "<github username>/<repository>"
}
```
3. Fill out the information of your plugin. Below you can find the description of each field (taken from the [obsidian-releases](https://github.com/obsidianmd/obsidian-releases#community-plugins) repo):
- `id`: A unique ID for your plugin. Make sure this is the same one you have in your `manifest.json`.
- `name`: The name of your plugin. This will be used to search for your plugin.
- `author`: The author's name.
- `description`: A short description of what your plugin does.
- `repo`: The GitHub repository identifier, in the form of `user-name/repo-name`, if your GitHub repo is located at `https://github.com/user-name/repo-name`.
- `branch`: (optional) A branch if you prefer to use a specific branch of your repo. Defaults to `master`.
4. Make a pull request at [https://github.com/obsidianmd/obsidian-releases](https://github.com/obsidianmd/obsidian-releases) to add your plugin.
5. Once you've opened the PR, you'll be prompted to use the pull request template. Complete everything in it and submit.
![[plugin-submission-PR-template.png]]
Expand Down