diff --git a/README.md b/README.md index 31e5155..8a5b5fa 100644 --- a/README.md +++ b/README.md @@ -1,96 +1,61 @@ -# Obsidian Sample Plugin +# Obsidian 源碼筆記插件 -This is a sample plugin for Obsidian (https://obsidian.md). +[技術支持 AntV X6](https://x6.antv.antgroup.com/) -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! +- 解析 Obsidian 筆記中的代碼區塊,繪製成方法調用鏈路的圖形,並在畫布中保留代碼區塊,方便查看 +![Demo](img/demo.gif) -This sample plugin demonstrates some of the basic functionality the plugin API can do. -- Changes the default font color to red using `styles.css`. -- 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. +## 二、如何使用 -## First time developing plugins? +### 1. 在 Markdown 的 代碼區塊 的 代碼註釋 部分,通過 關鍵字 編寫相關信息 -Quick starting guide for new plugin devs: +目前暫時只支持 Java -- 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. +| 支持的關鍵字 | 效果 | +| ------------ |-----------------------------| +| @class | 方法對應的類名稱 | +| @function | 方法名稱 | +| @call | 調用相關的方法,支持多個。格式: 類名稱 @ 方法名稱 | -## 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. -- `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" +```Java +/** + * Register metadata string. + * + * @class ShenyuClientHttpRegistryController + * @function registerMetadata(@RequestBody final MetaDataRegisterDTO metaDataRegisterDTO) + * @call RegisterClientServerDisruptorPublisher @ publish(final DataTypeParent data) + * + * @param metaDataRegisterDTO the meta data register dto + * @return the string + */ +@PostMapping("/register-metadata") +@ResponseBody +public String registerMetadata(@RequestBody final MetaDataRegisterDTO metaDataRegisterDTO) { + // 通过 Publisher 注册 元数据对象 + publisher.publish(metaDataRegisterDTO); + return ShenyuResultMessage.SUCCESS; } ``` -If you have multiple URLs, you can also do: - -```json -{ - "fundingUrl": { - "Buy Me a Coffee": "https://buymeacoffee.com", - "GitHub Sponsor": "https://github.com/sponsors", - "Patreon": "https://www.patreon.com/" - } +```Java +/** + * Register metadata string. + * + * @class RegisterClientServerDisruptorPublisher + * @function publish(final DataTypeParent data) + * + * @param metaDataRegisterDTO the meta data register dto + * @return the string + */ +@Override +public void publish(final DataTypeParent data) { + // 获取 DisruptorProvider + DisruptorProvider> provider = providerManage.getProvider(); + // 调用 DisruptorProvider 的 onData 方法,发送数据 + provider.onData(Collections.singleton(data)); } ``` - -## API Documentation - -See https://github.com/obsidianmd/obsidian-api diff --git a/img/demo.gif b/img/demo.gif new file mode 100644 index 0000000..b15b799 Binary files /dev/null and b/img/demo.gif differ diff --git a/manifest.json b/manifest.json index d049ee1..ff4187f 100644 --- a/manifest.json +++ b/manifest.json @@ -2,10 +2,9 @@ "id": "obsidian-code-note", "name": "Source Code Note Plugin", "version": "1.0.0", - "minAppVersion": "0.15.0", - "description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.", - "author": "Obsidian", - "authorUrl": "https://obsidian.md", - "fundingUrl": "https://obsidian.md/pricing", + "minAppVersion": "1.0.0", + "description": "This is a source code plugin for Obsidian. This plugin can help you organize source code note easily.", + "author": "Waiting", + "authorUrl": "https://github.com/waiting0324", "isDesktopOnly": false }