From 32441ae14c404a20372fceafb43a914ca317e0a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20Sch=C3=B6dler?= Date: Sat, 1 Apr 2023 12:06:51 +0200 Subject: [PATCH] Refactors docs --- DEV.md | 35 +++++++++++++++++++++++++++++++++++ README.md | 45 +++------------------------------------------ 2 files changed, 38 insertions(+), 42 deletions(-) create mode 100644 DEV.md diff --git a/DEV.md b/DEV.md new file mode 100644 index 0000000..c49077d --- /dev/null +++ b/DEV.md @@ -0,0 +1,35 @@ + +# Dev Notes + +## Roadmap + +* [x] General UX Improvement +* [ ] Add "Goto Source" action on suggestions + +## Refactors + +* [ ] Refactor handling / updating of `TreeItem`s. Use a reactive approach instead of manually updating the tree. +* [ ] Refactor `Editor.getWordLookup()` there has to be a better way of retrieving plain-text from an `Editor` (Without manually removing MD syntax operators) +* [ ] Move `register()` to the `TreeItemLeaf` base class and require derivatives to implement it. + +## 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 `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. +- 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 +- 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. +- Publish the release. + +> 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` + +## Adding to the community plugin list + +- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md +- Publish an initial version. +- 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. + +## API Documentation + +See https://github.com/obsidianmd/obsidian-api diff --git a/README.md b/README.md index 6e413bb..ab6a451 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # 🏹 Crossbow Crossbow is a plugin for [Obsidian](https://obsidian.md). -Its purpose is to provide crossreference suggestions based on the notes in your vault. -With that, your knowledge graph will gain some desperatly needed edges - it'll become more meaningful and interconnected. +Its purpose is to improve the interconnectedness of your notes by providing suggestions for backlinks based on the notes in your vault. ## How to use @@ -16,47 +15,9 @@ are ranked, based on the quality of the match. You can apply a match by clicking the appropriate icon next to the match. -## How to install +## How to install manually -*(Crossbow is currently not listed in the community plugins - it's not ready yet)* 1. Clone this repo. 2. `npm i` or `yarn` to install dependencies 3. `npm run build` to build crossbow. -4. Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`. - - -## Dev Notes - -### Roadmap - -* [x] General UX Improvement -* [ ] Add "Goto Source" action on suggestions -* [ ] Push to community plugin list - -### Refactors - -* [ ] Refactor handling / updating of `TreeItem`s. Use a reactive approach instead of manually updating the tree. -* [ ] Refactor `Editor.getWordLookup()` there has to be a better way of retrieving plain-text from an `Editor` (Without manually removing MD syntax operators) -* [ ] Move `register()` to the `TreeItemLeaf` base class and require derivatives to implement it. - -### 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 `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. -- 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 -- 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. -- Publish the release. - -> 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` - -### Adding to the community plugin list - -- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md -- Publish an initial version. -- 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. - -### API Documentation - -See https://github.com/obsidianmd/obsidian-api +4. Copy `main.js`, `styles.css`, `manifest.json` into a folder called `crossbow` in your vault's `.obsidian/plugins/` folder.