Debug help

In order for us to fix a bug, we need reliable and consistent steps that cause the bug every time.

If something looks wrong, first make sure you are using the latest Obsidian version and that your installer is up-to-date. The app and installer versions don’t need to match, but they shouldn’t be too far apart.
The installer update needs to be done manually: https://obsidian.md/

If you are using a community theme or community plugins, make sure to update them as well:

  • Check for theme updates: Settings > Appearance > Check for updates
  • Check for plugin updates: Settings > Community plugins > Check for updates

If things still look wrong:

  • On desktop, open the sandbox vault (Open Help > Sandbox Vault, this can be accessed from the command palette or the lower left ribbon) and see if you can reproduce the issue.
    Alternatively, in your own vault or on mobile:
  • Switch to the default theme, toggle off any custom CSS snippets (Settings > Appearance > CSS snippets), and disable all plugins by entering Restricted mode (Settings > Community plugins > Restricted mode > "Turn on") and restart Obsidian.

If the issue is gone, you need to figure out which of the extensions caused it. There is a community plugin that can help with it: https://obsidian.md/plugins?id=obsidian-divide-and-conquer
When you find the source of the problem, you can report it on the plugin’s/theme’s GitHub page:
For plugins: Settings > Community plugins Click the plugin’s name, then the GitHub link and open an issue.
For themes: Settings > Appearance > Manage Click on your theme, then the GitHub link and open an issue.

If the issue still happens, check if anyone has reported it on the forum in the bug reports category:
https://forum.obsidian.md/c/bug-reports/7
If not, you can post a bug report there (please follow the bug report template in the text box).

Bug report status
When we (the moderators) reproduced a bug, we add the repro tag to it. When we couldn’t reproduce it but think it might be a bug and are waiting for repro steps/confirmation from other users, we add the tag tracked.

5 Likes