Make installed community plugin information available offline

Use case or problem

Sometimes I’m forced to work offline, and I find that I may need information on the installed plugin configuration or usage instructions, for example Dataview syntax.

Proposed solution

Make the plugin information (as available when online) accessible offline.

Current workaround (optional)

None

4 Likes

Had similar thoughts recently. What if the community plugins and themes included the repository’s README.md file along with the manifest.json, theme.css, main.js et al?

2 Likes

Exactly what I had in mind!

My workaround is just to keep a clone of the GitHub repository in a local vault. Has all the docs and the source code too! This may be overkill, but it works

2 Likes

Interesting. The Readmes bundled with plugins aren’t usually the full support docs, but I can see the utility in many cases.

1 Like

Obsidian has the power to be the best “offline” second brain vault.
to have an offline help for the plugins should be standard!

1 Like

I was just going to create the same feature request! It boggles my mind that it still hasn’t been added into the app nor there’s any plugin to do this!

When I install plugins in Obsidian, sometimes I don’t immediately need them but anticipate using them in the future. However, as I frequently travel without reliable internet access, I find it challenging to remember the exact functionality of each installed plugin. Without documentation or a usage guide, I end up guessing or resorting to trial and error, which wastes time and effort.

As @StefanoCecere said, it should be a standard to save the readme, usage guide, or documentation automatically when users install community plugins. This way, even when offline, users can easily access information about each plugin’s functionality. Having this documentation readily available will eliminate guesswork and trial and error, allowing users to make the most of their plugins efficiently.

Please DEV’s @ryanjamurphy, we need a Plugin Mainfest/Readme/Documentation Preservation for offline usage!

I would also love a way to add personal additions to the readme just like @JAG suggested in this plugin request Plugin for Plugins Documentation