tpl
/
obsidian-sample-plugin
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' of github-naive231:naive231/obsidian-md-to-line-message

This commit is contained in:
naive231 2024-11-16 07:33:41 +08:00
parent cd18f67c72 3ca5d69db1
commit ee70e40a4b
2 changed files with 162 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 周乃宏
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

206
README.md
View File

@ -1,71 +1,163 @@
# Obsidian Sample Plugin # Obsidian-flavor Markdown texts to LINE-flavor messages
This is a sample plugin for Obsidian (https://obsidian.md). The goal of this plugin is to convert Obsidian-flavored Markdown texts to messages based on LINE Messenger Chat message formats.
This project uses TypeScript to provide type checking and documentation. ## Simple texts conversions
The repo depends on the latest plugin API (obsidian.d.ts) in TypeScript Definition format, which contains TSDoc comments describing what it does.
This sample plugin demonstrates some of the basic functionality the plugin API can do. Here are some supported Obsidian-flavored Markdown texts:
- 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. **bold**
2. *italic*
3. ~~strike~~
4. ==emphasize==
5. `quote`
6. - [ ] unchecked
7. - [x] checked
8. # heading1
9. ## heading2
```
Quick starting guide for new plugin devs: According the reference source in [Formatting chat messages](
"https://help.line.me/line/desktop/categoryId/50000280/3/pc?lang=en&contentId=20013876"), it will convert them into:
- 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). 1. {*bold*}
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. 2. {_italic_}
- Install NodeJS, then run `npm i` in the command line under your repo folder. 3. {~strike~}
- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`. 4. {`emphasize`}
- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`. 5. {{quote}}
- Reload Obsidian to load the new version of your plugin. 6. {🟩} unchecked
- Enable plugin in settings window. 7. {✅} checked
- For updates to the Obsidian API run `npm update` in the command line under your repo folder. 8. 【 heading1 】
9. ▋heading2
```
## Releasing new releases The "{xxx}" should be replaced with a space character. For example, the "{*bold}" should be the " *bold* ".
- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release. ## Hierarchical Numbering List
- 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`. If we have list texts like this:
> 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 ```
1. itemA
1. ia1
2. ia2
2. itemB
1. ib1
2. ib2
3. itemC
1. ic1
2. ic2
1. ic21
```
Or this:
```
- itemA
- ia1
- ia2
- itemB
- ib1
- ib2
- itemC
- ic1
- ic2
- ic21
```
It will convert the list to hierarchical numbering list:
```
1. itemA
1.1 ia1
1.2 ia2
2. itemB
2.1 ib1
2.2 ib2
3. itemC
3.1 ic1
3.2 ic2
3.2.1ic21
```
Each item in hierarchical list should be on a new line without any indents.
## Usage
**Chinese texts are also supported**. After installed and enabled the plugin, when you fill Obsidian-flavor Markdown texts into a "line" code block like this:
```
```line
# 主標題
這裡有一段文字,用來測試**粗體**,*斜體*,~~刪除線~~,==強調文字==,和`引言`.
## 次標題
在清單中的表現是這樣的:
1. **粗體**
1. 數字清單測試A
2. 數字清單測試B
1. 數字清單測試C
2. *斜體*
3. ~~刪除線~~
4. ==強調文字==
5. `引言`
- [ ] 未完成項目
- 符號清單測試A
- 符號清單測試B
- 符號清單測試C
- [x] 已完成項目
```
This plugin should convert those texts to this:
```markdown
【 主標題 】
這裡有一段文字,用來測試 *粗體* , _斜體_ , ~刪除線~ , `強調文字` ,和 {引言} .
▋ 次標題
在清單中的表現是這樣的:
1. *粗體*
1.1 數字清單測試A
1.2 數字清單測試B
1.2.1 數字清單測試C
2. _斜體_
3. ~刪除線~
4. `強調文字`
5. {引言}
🟩 1. 未完成項目
1.1 符號清單測試A
1.1.1 符號清單測試B
1.2 符號清單測試C
✅ 2. 已完成項目
```
## Others
### Adding your plugin to the community plugin list
- Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines). - Check the [plugin guidelines](https://docs.obsidian.md/Plugins/Releasing/Plugin+guidelines).
- Publish an initial version. - Publish an initial version.
- Make sure you have a `README.md` file in the root of your repo. - 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. - Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
## How to use ### Manually installing the plugin
- 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/`. - Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
## Improve code quality with eslint (optional) ### Funding URL
- [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. You can include funding URLs where people who use your plugin can financially support it.
@ -76,19 +168,3 @@ The simple way is to set the `fundingUrl` field to your link in your `manifest.j
"fundingUrl": "https://buymeacoffee.com" "fundingUrl": "https://buymeacoffee.com"
} }
``` ```
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/"
}
}
```
## API Documentation
See https://github.com/obsidianmd/obsidian-api