Plugin will not turn on! about obsidian-homepage HOT 8 CLOSED

If installing from source, you need to compile main.ts into main.js yourself. Use npm run build to do so. (If you were trying to do this because it wouldn't install via the plugins browser, I messed something up that meant it wouldn't work. Sorry about that, it should be fixed now.)

from obsidian-homepage.

from obsidian-homepage.

compile.

I didn’t see any instructions at Github to compile.

now there are instructions ;). I thought it would be kinda obvious, but I guess it isn't. I'd just install it from the plugin browser though, now that I've fixed the issues with that.

from obsidian-homepage.

To clarify, if you haven't used the Node ecosystem before, you'll have to run npm i beforehand to initialise things first. I'll put that in the readme as well.

from obsidian-homepage.

from obsidian-homepage.

As the installation instructions state, you can also install it using Obsidian's built-in plugin browser. I would recommend doing that if you don't have any experience with Node - it would be much easier.

If you still can't use that version of the plugin, let me know, and I'll do my best to help fix the issue.

from obsidian-homepage.

from obsidian-homepage.

That was since it takes a bit for plugins to be included in the plugin browser. Each plugin has to be manually approved by the Obsidian devs.

Is there somewhere you can point me to that explains the “npm i” process for “compiling”? I’ll be googling as well.

Basically, NPM is a package manager for using JavaScript outside the browser as a scripting language similar to Python. Though it's commonly associated with the Node runtime, it can be used for other JavaScript projects as well, like Obsidian. If you have Homebrew or MacPorts, it can be obtained from there.

npm i downloads all packages for the project and sets up a few system files; NPM is rather poorly designed unusual that it installs all the packages on a per-project basis by default, so this has to be done for each project (ie. each plugin) separately. One of these packages is TypeScript, a version of JavaScript by Microsoft that is a strongly typed language. npm build uses it in tandem with another package, Rollup,* to compile all the plugin's TypeScript files into a single JavaScript file.

*Though since this is a rather small plugin with only one TS file, it's not strictly necessary.

from obsidian-homepage.