#

2025-02-28 01:29:33 +05:30 · 2025-02-28 01:29:33 +05:30 · 2e15045640
parent 0658716e0d
commit 2e15045640
1 changed files with 62 additions and 79 deletions
--- a/README.md
+++ b/README.md
@ -1,94 +1,77 @@
-# Obsidian Sample Plugin
+# GitHub Sync Plugin for Obsidian

-This is a sample plugin for Obsidian (https://obsidian.md).
+## 🌟 Overview
+This **GitHub Sync Plugin** allows you to synchronize your Obsidian notes with a GitHub repository using the **GitHub API** (without `isomorphic-git`). It works across **Windows, Linux, Android, and iOS**.

-This project uses TypeScript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
+## 🚀 Features
+- **Clone** repository (manual setup required)
+- **Pull** latest changes from GitHub
+- **Commit** with a default message `#`
+- **Push** changes to GitHub
+- **Authentication** via GitHub Personal Access Token (hidden after first input)

-This sample plugin demonstrates some of the basic functionality the plugin API can do.
- Adds a ribbon icon, which shows a Notice when clicked.
- Adds a command "Open Sample Modal" which opens a Modal.
- Adds a plugin setting tab to the settings page.
- Registers a global click event and output 'click' to the console.
- Registers a global interval which logs 'setInterval' to the console.
+## 📥 Installation

-## First time developing plugins?
+### **Manual Installation**
+1. Download the latest release from [GitHub Releases](#).
+2. Copy these files to your Obsidian plugin directory:
+   - `dist/main.js`
+   - `manifest.json`
+   - `versions.json`
+3. Restart Obsidian and enable the plugin from **Settings → Community Plugins**.

-Quick starting guide for new plugin devs:
+**Plugin Folder Path:**
+- **Windows:** `%APPDATA%\Obsidian\plugins\github-sync`
+- **Linux:** `~/.config/Obsidian/plugins/github-sync`
+- **Android:** `/storage/emulated/0/Obsidian/.obsidian/plugins/github-sync`
+- **iOS:** (Community Plugin installation required)

- 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.
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
- Install NodeJS, then run `npm i` in the command line under your repo folder.
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
- Reload Obsidian to load the new version of your plugin.
- Enable plugin in settings window.
- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+## 🔧 Setup
+1. **Go to Plugin Settings** (`Settings → Community Plugins → GitHub Sync`)
+2. **Enter your GitHub details:**
+   - Repository Owner (your GitHub username or organization)
+   - Repository Name
+   - Branch Name (default: `main`)
+   - Authentication Token *(hidden after first input)*
+   - Folder Path (subfolder in repo to sync, default: `/`)
+3. **Save settings and restart Obsidian**.

-## Releasing new releases
+## 📌 Usage

- 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.
+### **Pull Latest Changes**
+1. Open **Command Palette** (`Ctrl + P` or `Cmd + P` on macOS)
+2. Search for **Pull from GitHub** and execute it.
+3. The latest changes will be downloaded into Obsidian.

-> 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`
+### **Commit & Push**
+1. Open **Command Palette**
+2. Search for **Commit & Push** and execute it.
+3. All files in the specified folder will be committed and pushed with the message `#`.

-## Adding your plugin to the community plugin list
-
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- 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.
-
-## How to use
-
- Clone this repo.
- Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## Improve code quality with eslint (optional)
- [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. 
- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-## Funding URL
-
-You can include funding URLs where people who use your plugin can financially support it.
-
-The simple way is to set the `fundingUrl` field to your link in your `manifest.json` file:
-
-```json
-{
-    "fundingUrl": "https://buymeacoffee.com"
-}
+## 🛠️ Build from Source
+To build this plugin from source:
+```sh
+npm install
+npm run build
 ```
+This generates the `dist/` folder with the necessary files.

-If you have multiple URLs, you can also do:
+## 📢 Contributing
+Want to improve this plugin? Feel free to fork this repository and submit a pull request!

-```json
-{
-    "fundingUrl": {
-        "Buy Me a Coffee": "https://buymeacoffee.com",
-        "GitHub Sponsor": "https://github.com/sponsors",
-        "Patreon": "https://www.patreon.com/"
-    }
-}
-```
+## 📜 License
+This project is licensed under the **MIT License**.

-## API Documentation
+## ❓ FAQ
+### *Why is my authentication token hidden after first input?*
+This is a security feature to prevent accidental exposure of your GitHub token.
+
+### *Can I sync only a specific folder from my repository?*
+Yes! Set the **Folder Path** in settings to the specific subfolder you want to sync.
+
+### *How do I update the plugin?*
+Download the latest version and replace the existing files in your Obsidian plugin folder.
+
+---
+🚀 **Enjoy seamless GitHub sync in Obsidian!**

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