Update README.md
This commit is contained in:
parent
b7bf9c59c4
commit
d2dc2455e9
76
README.md
76
README.md
|
@ -35,7 +35,7 @@ The "{xxx}" should be replaced with a space character. For example, the "{*bold}
|
||||||
|
|
||||||
If we have list texts like this:
|
If we have list texts like this:
|
||||||
|
|
||||||
%%%
|
```
|
||||||
1. itemA
|
1. itemA
|
||||||
1. ia1
|
1. ia1
|
||||||
2. ia2
|
2. ia2
|
||||||
|
@ -46,11 +46,11 @@ If we have list texts like this:
|
||||||
1. ic1
|
1. ic1
|
||||||
2. ic2
|
2. ic2
|
||||||
1. ic21
|
1. ic21
|
||||||
%%%
|
```
|
||||||
|
|
||||||
Or this:
|
Or this:
|
||||||
|
|
||||||
%%%
|
```
|
||||||
- itemA
|
- itemA
|
||||||
- ia1
|
- ia1
|
||||||
- ia2
|
- ia2
|
||||||
|
@ -61,11 +61,12 @@ Or this:
|
||||||
- ic1
|
- ic1
|
||||||
- ic2
|
- ic2
|
||||||
- ic21
|
- ic21
|
||||||
%%%
|
```
|
||||||
|
|
||||||
|
|
||||||
It will convert the list to hierarchical numbering list:
|
It will convert the list to hierarchical numbering list:
|
||||||
|
|
||||||
%%%
|
```
|
||||||
1. itemA
|
1. itemA
|
||||||
1.1 ia1
|
1.1 ia1
|
||||||
1.2 ia2
|
1.2 ia2
|
||||||
|
@ -76,23 +77,80 @@ It will convert the list to hierarchical numbering list:
|
||||||
3.1 ic1
|
3.1 ic1
|
||||||
3.2 ic2
|
3.2 ic2
|
||||||
3.2.1ic21
|
3.2.1ic21
|
||||||
%%%
|
```
|
||||||
|
|
||||||
Each item in hierarchical list should be on a new line without any indents.
|
Each item in hierarchical list should be on a new line without any indents.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
## Adding your plugin to the community plugin list
|
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.
|
||||||
|
|
||||||
## Manually installing the plugin
|
### 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/`.
|
||||||
|
|
||||||
## Funding URL
|
### 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.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue