Skip to content
This repository was archived by the owner on Jun 26, 2025. It is now read-only.

Commit f59ce88

Browse files
committed
docs: add submission guidelines for snippets in README
1 parent 3872f5d commit f59ce88

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,26 @@
1010
- [x] Style Store
1111
- [x] Search
1212

13+
## Submit your snippet
14+
To add your plugin to the list, make a pull request to the `snippets.json` file. Please add your snippet to the end of the list.
15+
16+
- `id`: A unique ID for your snippet.
17+
- `name`: The name of your snippet.
18+
- `author`: The author's name.
19+
- `description`: A short description of what your snippet does.
20+
- `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.
21+
- `folder`: The folder name where your snippet is located. This is the folder name inside the repository, not the full path.
22+
23+
Your Repo has to be public, otherwise the snippet will not be installed and has to be in the following structure:
24+
25+
```
26+
├── folder1
27+
│ ├── snippet.css
28+
│ ├── README.md
29+
└──folder2
30+
├── snippet.css
31+
├── README.md
32+
33+
```
34+
*Notice that every snippet consists of a `snippet.css` and `README.md` file. The `README.md` file is optional, but it is recommended to add it to provide more information about your snippet. The `snippet.css` file is the actual CSS code that will be applied to your Obsidian vault.*
35+

0 commit comments

Comments
 (0)