treethought.xyz
AT protocol bookmarking platforms in obsidian
update readme
+15
-82
+15
-82
README.md
+15
-82
README.md
···
1
-
# Obsidian Sample Plugin
1
+
# ATmark
2
2
3
-
This is a sample plugin for Obsidian (https://obsidian.md).
3
+
Obsidian plugin for AT Protocol bookmarking platforms.
4
4
5
-
This project uses TypeScript to provide type checking and documentation.
6
-
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
5
+
## Supported platforms
7
6
8
-
This sample plugin demonstrates some of the basic functionality the plugin API can do.
9
-
- Adds a ribbon icon, which shows a Notice when clicked.
10
-
- Adds a command "Open modal (simple)" which opens a Modal.
11
-
- Adds a plugin setting tab to the settings page.
12
-
- Registers a global click event and output 'click' to the console.
13
-
- Registers a global interval which logs 'setInterval' to the console.
7
+
- **Semble** (`network.cosmik.*`) - Collections and cards
14
8
15
-
## First time developing plugins?
9
+
## Installation
16
10
17
-
Quick starting guide for new plugin devs:
11
+
Install via [BRAT](https://github.com/TfTHacker/obsidian42-brat):
18
12
19
-
- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
20
-
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
21
-
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
22
-
- Install NodeJS, then run `npm i` in the command line under your repo folder.
23
-
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
24
-
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
25
-
- Reload Obsidian to load the new version of your plugin.
26
-
- Enable plugin in settings window.
27
-
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
13
+
1. Install the BRAT plugin from Community Plugins
14
+
2. Open BRAT settings
15
+
3. Click "Add Beta plugin"
16
+
4. Enter: `treethought/obsidian-atmark`
17
+
5. Enable the plugin in Community Plugins
28
18
29
-
## Releasing new releases
30
-
31
-
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
32
-
- 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.
33
-
- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
34
-
- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
35
-
- Publish the release.
36
-
37
-
> 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`.
38
-
> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
39
-
40
-
## Adding your plugin to the community plugin list
19
+
## Configuration
41
20
42
-
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
43
-
- Publish an initial version.
44
-
- Make sure you have a `README.md` file in the root of your repo.
45
-
- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
46
-
47
-
## How to use
48
-
49
-
- Clone this repo.
50
-
- Make sure your NodeJS is at least v16 (`node --version`).
51
-
- `npm i` or `yarn` to install dependencies.
52
-
- `npm run dev` to start compilation in watch mode.
53
-
54
-
## Manually installing the plugin
55
-
56
-
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
57
-
58
-
## Improve code quality with eslint
59
-
- [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.
60
-
- This project already has eslint preconfigured, you can invoke a check by running`npm run lint`
61
-
- Together with a custom eslint [plugin](https://github.com/obsidianmd/eslint-plugin) for Obsidan specific code guidelines.
62
-
- A GitHub action is preconfigured to automatically lint every commit on all branches.
63
-
64
-
## Funding URL
65
-
66
-
You can include funding URLs where people who use your plugin can financially support it.
67
-
68
-
The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
69
-
70
-
```json
71
-
{
72
-
"fundingUrl": "https://buymeacoffee.com"
73
-
}
74
-
```
75
-
76
-
If you have multiple URLs, you can also do:
77
-
78
-
```json
79
-
{
80
-
"fundingUrl": {
81
-
"Buy Me a Coffee": "https://buymeacoffee.com",
82
-
"GitHub Sponsor": "https://github.com/sponsors",
83
-
"Patreon": "https://www.patreon.com/"
84
-
}
85
-
}
86
-
```
87
-
88
-
## API Documentation
89
-
90
-
See https://docs.obsidian.md
21
+
1. Open Settings > ATmark
22
+
2. Enter your handle or DID
23
+
3. Enter your app password (create one at Settings > Privacy and security > App passwords on Bluesky)