https://github.com/korbinzhao/obsidian-textfileview-plugin-sample

A sample of developing a custom Obsidian TextFileView plugin, which includes customizing TextFileView, file operation, auto-saving, unload handling, SASS, and other required code logic.
https://github.com/korbinzhao/obsidian-textfileview-plugin-sample

Last synced: about 1 year ago
JSON representation

A sample of developing a custom Obsidian TextFileView plugin, which includes customizing TextFileView, file operation, auto-saving, unload handling, SASS, and other required code logic.

• Host: GitHub
• URL: https://github.com/korbinzhao/obsidian-textfileview-plugin-sample
• Owner: michaeljohnn
• License: mpl-2.0
• Created: 2023-07-09T12:35:24.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-07-09T13:11:14.000Z (almost 3 years ago)
• Last Synced: 2025-04-06T08:11:47.093Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://korbinzhao.deno.dev
• Size: 72.3 KB
• Stars: 25
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# obsidian-textfileview-plugin-sample

A sample of developing a custom Obsidian TextFileView plugin, which includes customizing TextFileView, file operation, auto-saving, unload handling, SASS, and other required code logic.

![](https://img.alicdn.com/imgextra/i3/O1CN01TxZIt61UjK0yJOv88_!!6000000002553-0-tps-4674-2422.jpg)

## Development

### Download the sample plugin

1. Open a terminal window and change the project directory to the plugins directory.

`cd path/to/vault/.obsidian/plugins`

2. Clone the sample plugin using Git.

`git clone git@github.com:korbinzhao/obsidian-textfileview-plugin-sample.git`

### Build the plugin

1. Navigate to the plugin directory.

`cd obsidian-textfileview-plugin-sample`

2. Install dependencies

`yarn`

3. Compile the source code

`yarn start`

### Enable the plugin

To load a plugin in Obsidian, you first need to enable it.

1. In Obsidian, open Settings.

2. In the side menu, select Community plugins.

3. Select Turn on community plugins.

4. Under Installed plugins, enable the Sample Plugin by selecting the toggle button next to it.

You're now ready to use the plugin in Obsidian. Next, we'll make some changes to the plugin.

![](https://img.alicdn.com/imgextra/i2/O1CN01g7s9l21DbDXApH1M3_!!6000000000234-0-tps-4658-2376.jpg)

### More

Visit [Obsidian Develop Docs](https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin) for more development guide.

## Feed my cat

Like this sample, feed my cat.

:point_right: Feed my cat

## Buy me a coffee

Like this sample, buy me a coeffe.

:point_right: