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.

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 [email protected]: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.

More

Visit Obsidian Develop Docs 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: