https://github.com/THeK3nger/obsidian-plugin-template

Template for Obsidian.md Plugins
https://github.com/THeK3nger/obsidian-plugin-template

obsidian-md obsidian-plugin

Last synced: 2 months ago
JSON representation

Template for Obsidian.md Plugins

• Host: GitHub
• URL: https://github.com/THeK3nger/obsidian-plugin-template
• Owner: THeK3nger
• Archived: true
• Created: 2020-10-27T19:09:30.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-01-10T10:56:08.000Z (about 3 years ago)
• Last Synced: 2024-08-02T05:11:25.598Z (5 months ago)
• Topics: obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 13.7 KB
• Stars: 37
• Watchers: 4
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-obsidian - obsidian-plugin-template
• jimsghstars - THeK3nger/obsidian-plugin-template - Template for Obsidian.md Plugins (TypeScript)

README

        
## Obsidian Plugin Template

This templates includes a barebone directory structure for an Obsidian Plugin. Bundling is based on [Rollup.js](https://rollupjs.org/).

**NOTE:** This is not the official template. You can find [the official sample plugin here](https://github.com/obsidianmd/obsidian-sample-plugin). This is a plugin template I customized with a nicer (for me) directory structure and some additional tool (like featuring automatic releases with Github's Actions).

## How to use it

You can click on the "Use this template" button above.

### Enable Github's Actions

After you created a new repository, remember to rename the `RENAME.github` to `.github` to enable the GitHub's Actions. Then go in `.github/workflows/release.yml` and change `PLUGIN_NAME` on line 10.

## How to compile the plugin

First, install the dependencies with

```bash

npm i

```

Then, you can compile the plugin with:

```bash

npm run build

```

This will create a `main.js` file in the project root. That is the entry point of your plugin.