Skip to content

Latest commit

 

History

History
159 lines (108 loc) · 5.62 KB

README.md

File metadata and controls

159 lines (108 loc) · 5.62 KB
Raw

Obsidian Template Plugin

Note

This is one of the plugins of the collections of plugins called Nólëbase Integrations. You can explore the other plugins in the collection in the official documentation site of Nólëbase Integrations.

⚠️ To you, the plugin developer.

This is a template plugin for you to start developing your own Obsidian plugin. It is a good starting point for you to develop your own plugin. You can clone this repository and start developing your own plugin.

We use the most advanced technologies to develop this plugin, including:

So everything is configured for you to start developing your own plugin, immediately.

⚠️ Before publishing

  1. Replace all the obsidian-plugin-template with the name of your plugin:
    1. In the manifest.json file.
    2. In the package.json file.
    3. In the README.md file.
  2. Replace all the Obsidian Template Plugin with the name of your plugin:
    1. In the manifest.json file.
    2. In the package.json file.
    3. In the README.md file.
  3. Fill in a URL to your repository. You can replace with https://github.com/nolebase/obsidian-plugin-template
  4. Fill in the Why, Features, What can you do with it, Demos, How to install, TODOs, feel free to remove the sections that are not needed.
  5. Replace the name SomeViewPlugin and SomePlugin with your own plugin name.

⚠️ How to publish?

  1. Modify the version in the manifest.json file.
  2. Modify the version in the package.json file.
  3. Push the changes to the repository.
  4. Go to the [Release] page of the repository.
  5. Create a new release with the tag name as the version number.
  6. Sit back and relax, the plugin will be published with CI/CD pipelines automatically.

🤔 Why

Introduce your plugin! Explain why you made it, why would users choose yours!

🎨 Features

  • 📦 Out of the box support.
  • 🚀 Blazingly fast.
  • 💡 You define it.

💡 What can you do with it

  • Help users to imagine what they can do, show your imagination.

📺 Demos

Show me what you can do

How it looks like

Perhaps a GIF?

😎 How to install

Warning

Currently Obsidian Template Plugin is in alpha stage, it wasn't guaranteed to work properly and keep the compatibility with the future versions of itself.

But it is encouraged to try it out and give feedbacks. If you find and bugs or have any suggestions, please feel free to open an issue on GitHub.

Currently, it is a bit hard to install the plugin for now before it is published to the official Obsidian plugin store. Manual downloading and installation is required.

Install with beta testing helper BRAT plugin

  1. Install the BRAT plugin right from the official Obsidian plugin store.
  2. Enable the BRAT plugin in the community plugins settings menu.
  3. Open Command palette to choose BRAT: Plugins: Add a beta plugin for testing.
  4. Copy and paste the following link to the first field of the new prompted dialog:
https://github.com/nolebase/obsidian-plugin-template
  1. Find the needed released version on Release page of Obsidian UnoCSS Plugin, for example, fill in 0.1.0.
  2. Enable the "Obsidian Template Plugin" plugin from the Installed plugins list.

Install manually

  1. Navigate to the Release page of Obsidian Template Plugin
  2. Find the latest version of the plugin.
  3. Download the main.js file and manifest.json file.
  4. Open up the .obsidian/plugins directory of your Obsidian vault.
  5. If no .obsidian/plugins directory exists, create one.
  6. Create a new directory named obsidian-plugin-template inside the .obsidian/plugins directory.
  7. Move main.js file and manifest.json file into the obsidian-plugin-template directory.

The directory structure should look like this after these steps:

❯ tree
.
├── main.js
├── manifest.json
  1. Enable the "Obsidian Template Plugin" plugin from the "Installed plugins" list.

⏳ TODOs

  • Anything on the roadmap?

💻 How to develop

  1. As Build a plugin - Developer Documentation has suggested, create a separate vault for development.
  2. (Optional) Install the hot-reload plugin: pjeby/hot-reload.
  3. Create a .obsidian/plugins directory in the vault root.
  4. Clone this repository into the .obsidian/plugins directory.
  5. Install dependencies
pnpm install

If you use @antfu/ni, you can also use the following command:

ni
  1. Build the plugin for development
pnpm run build:dev

If you use @antfu/ni, you can also use the following command:

nr build
  1. Reload Obsidian to see the changes. (If you use the hot-reload plugin, you don't need to reload Obsidian manually.)

Reloading can be called from the command palette with Reload app without saving command.

🔨 How to build

pnpm run build

If you use @antfu/ni, you can also use the following command:

nr build

Written with ♥