{"id":19795935,"url":"https://github.com/korbinzhao/obsidian-textfileview-plugin-sample","last_synced_at":"2025-05-01T03:30:40.034Z","repository":{"id":224414956,"uuid":"664263545","full_name":"michaeljohnn/obsidian-textfileview-plugin-sample","owner":"michaeljohnn","description":"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.","archived":false,"fork":false,"pushed_at":"2023-07-09T13:11:14.000Z","size":74,"stargazers_count":25,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-06T08:11:47.093Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://korbinzhao.deno.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaeljohnn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-09T12:35:24.000Z","updated_at":"2025-03-08T11:31:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"16598aa7-81c4-4a89-9d1d-4ab958c7e8b4","html_url":"https://github.com/michaeljohnn/obsidian-textfileview-plugin-sample","commit_stats":null,"previous_names":["korbinzhao/obsidian-textfileview-plugin-sample","michaeljohnn/obsidian-textfileview-plugin-sample"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljohnn%2Fobsidian-textfileview-plugin-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljohnn%2Fobsidian-textfileview-plugin-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljohnn%2Fobsidian-textfileview-plugin-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeljohnn%2Fobsidian-textfileview-plugin-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaeljohnn","download_url":"https://codeload.github.com/michaeljohnn/obsidian-textfileview-plugin-sample/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251817825,"owners_count":21648812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T07:17:51.625Z","updated_at":"2025-05-01T03:30:40.029Z","avatar_url":"https://github.com/michaeljohnn.png","language":"TypeScript","funding_links":["https://www.buymeacoffee.com/korbinzhao"],"categories":[],"sub_categories":[],"readme":"# obsidian-textfileview-plugin-sample\n\nA sample of developing a custom Obsidian TextFileView plugin, which includes customizing TextFileView, file operation, auto-saving, unload handling, SASS, and other required code logic.\n\n![](https://img.alicdn.com/imgextra/i3/O1CN01TxZIt61UjK0yJOv88_!!6000000002553-0-tps-4674-2422.jpg)\n\n## Development\n\n### Download the sample plugin\n1. Open a terminal window and change the project directory to the plugins directory.\n`cd path/to/vault/.obsidian/plugins`\n\n2. Clone the sample plugin using Git.\n`git clone git@github.com:korbinzhao/obsidian-textfileview-plugin-sample.git`\n\n### Build the plugin\n1. Navigate to the plugin directory.\n`cd obsidian-textfileview-plugin-sample`\n\n2. Install dependencies\n`yarn`\n\n3. Compile the source code\n`yarn start`\n\n### Enable the plugin\nTo load a plugin in Obsidian, you first need to enable it.\n\n1. In Obsidian, open Settings.\n2. In the side menu, select Community plugins.\n3. Select Turn on community plugins.\n4. Under Installed plugins, enable the Sample Plugin by selecting the toggle button next to it.\nYou're now ready to use the plugin in Obsidian. Next, we'll make some changes to the plugin.\n\n![](https://img.alicdn.com/imgextra/i2/O1CN01g7s9l21DbDXApH1M3_!!6000000000234-0-tps-4658-2376.jpg)\n\n\n### More\nVisit [Obsidian Develop Docs](https://docs.obsidian.md/Plugins/Getting+started/Build+a+plugin) for more development guide.\n\n\n## Feed my cat\nLike this sample, feed my cat.\n:point_right: \u003ca href=\"https://afdian.net/a/wantian\" target=\"_blank\"\u003eFeed my cat\u003c/a\u003e\n\n## Buy me a coffee\nLike this sample, buy me a coeffe.\n:point_right: \u003ca href=\"https://www.buymeacoffee.com/korbinzhao\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/default-orange.png\" alt=\"Buy Me A Coffee\" height=\"39\" width=\"175\"\u003e\u003c/a\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkorbinzhao%2Fobsidian-textfileview-plugin-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkorbinzhao%2Fobsidian-textfileview-plugin-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkorbinzhao%2Fobsidian-textfileview-plugin-sample/lists"}