Help/Docs Offline Accessibility

Use case or problem

The problem lies in the inaccessibility of official documentation in the absence of the internet.

Proposed solution

  • Add the ability to download documentation on the documentation page or download page
  • Install documentation together with Obsidian itself (… and provide access to it as a separate Sandbox-like vault?)

Current workaround

  • Download documentation in all languages from the GitHub repository and delete unnecessary ones
  • Use third-party methods to download the directory with documentation in the desired language

The disadvantage of both workarounds is that the documentation may not be downloaded in advance, and it will be useful precisely at the moment when there is no Internet access and it cannot be downloaded.

Related feature requests

5 Likes

Desperately need this especially as an Insider that always updates to the latest Catalyst version, especially now that the new features of Bases are rolling.

We used to package it with the app until the help docs grew so big that it increased bundle size.

  • Add the ability to download documentation on the documentation page or download page
  • Install documentation together with Obsidian itself (… and provide access to it as a separate Sandbox-like vault?)

Might be able to do something like this. No guarantees, but will inquire.

I would like to suggest adding an offline version of Obsidian’s documentation directly within the app, especially inside the experimental vault. The current online documentation already features a graph linking different sections together, which demonstrates the value of interconnected guides.

Having this offline inside the vault would:

  • Allow users to access all guides and tutorials without an internet connection.

  • Preserve the interactive graph structure for easier navigation and learning.

  • Make onboarding and troubleshooting more seamless, particularly in environments with limited connectivity.

This feature would significantly enhance usability and learning for all users. I hope you will consider including it in a future release.

1 Like

The docs were part of the app bundle a long time ago. However, they were removed because the got too big.

You can manually download the docs and use them in an obsidian vault here.

1 Like