Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jessmartin/obsidian-dxos-plugin

Sync Obsidian vault markdown files with DXOS's ECHO data store.
https://github.com/jessmartin/obsidian-dxos-plugin

Last synced: 11 days ago
JSON representation

Sync Obsidian vault markdown files with DXOS's ECHO data store.

Awesome Lists containing this project

README 

        
# Obsidian DXOS Sync Plugin



This is a plugin for [Obsidian](https://obsidian.md) that syncs Markdown files with [DXOS](https://dxos.org).



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.



**Note:** The Obsidian API is still in early alpha and is subject to change at any time!



## Development



1. Create a new Obsidian vault for testing. Clone this repo into the `.obsidian/plugins` folder of your new vault.



2. Install dependencies:



   ```bash

   pnpm install

   ```



3. Build the plugin:



   ```bash

    pnpm run dev

   ```



4. Open the Obsidian vault and enable the plugin in Community Plugins settings under Installed Plugins.



If the plugin is installed successfully, you should see a new Settings item called "DXOS Sync" in the Community Plugins section. In the list of settings, you should see a setting called DXOS Client Version that displays the current version of the DXOS Client library.



## 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 your plugin 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.



## 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\`