obsidian-community / obsidian-community-lib Goto Github PK

Hello,

I've written some code to render Markdown to HTML. The goal was to be able to copy a document to clipboard so it can be pasted for instance to gmail.

Another developer approached me to expose the rendering as an API. I'm not very enthusiastic about other plugins depending directly on my plugin, so I was thinking of extracting the functionality into a separate library. I've seen frequent questions about overcoming Obsidian's MarkdownRenderer shortcomings on Discord, and I've seen this implemented in several plugins, so it would probably have some utility to other plugin developers.

I thought that this library would be a good place to include it. I can of course also publish it as a separate library. What do you think ?

If one compiles their Plugin with this Library, using the esbuild (or old rollup config) from the sample Plugin, all provided methods are included, even the ones that aren't used.
I am not sure if this is an Issue of this Library or the sample Plugin configuration, and while the Library is pretty small it's also not that big of a deal, but it might become one in the Future.

Title says it all. This is the specific line:

https://github.com/obsidian-community/obsidian-community-lib/blob/main/src/utils.ts#L500

@phibr0, when using one of the functions from the lib, I get this error:

The App I extended in the community-lib doesn't extend 'obsidians' App when using a 3rd party lib.

I'm not sure what the solution is. Maybe we can just remove the interface? Or maybe keep it in the lib for type-checking purposes, but don't export it? But I was reading, and declare module ... is automatically exported, I don't think we have a choice

openOrSwitch tries to access the path of the active file, which is undefined when there is no active file.

Hey there!

A while back, I made a couple of Obsidian libraries for my plugin: obsidian-undocumented, which contains unofficial type definitions for Obsidian's internal API; and obsidian-extra, which provides a bunch of functions using those unofficial definitions.

Would there be any interest in merging obsidian-extra into this project? The projects seem to have a similar goal but are structured slightly differently. Where this project has a single file for all the functions, obsidian-extra has one file per function/feature and tries to separate its exports into safe and unsafe variants.

Here's the project repo.