Skip to content

Catch problems before you publish

Before you ship a page, you want to know it does not have a broken link, a footnote missing its definition, a definition that is no longer used, or a snippet that no longer resolves. Zensical Studio flags all of this the moment it happens, not just when you go looking for it.

Example project

This workflow uses the project in acme-example-project.zip; the same diagnostics apply in any project.

Suppose getting-started.md's "Next steps" linked more precisely to the Agent permissions section, and you typed agent-permission, missing the final "s". Zensical Studio underlines the anchor immediately: #agent-permission does not exist, #agent-permissions does. The problem shows up both inline and in Problems panelProblems panelDiagnostics panelProblems tool window.

Unused and duplicate definitions

Let's repair the previous mistake by adding the missing 's' but then removing the last 's' from the link definition label:

You can see that two errors are logged in the Problems panelProblems panelDiagnostics panelProblems tool window, one for the link that does not have a definition anymore and one for the now orphaned definition.

Another kind of error is to have two link definitions with the same label. Zensical Studio warns about this as well.

Broken footnotes

Say we introduce a typo in a footnote, so that the footnote and its definition no longer match. This will be shown by underlining of both the footnote and the footnote definition, which is orphaned. You can also see the errors in the Problems panel. If it is not open in your editor, use Open the Problems panelOpen the Problems panelOpen the Diagnostics panelOpen the Problems tool windowCtrl+Shift+MmacOSCmd+Shift+MWindowsCtrl+Shift+MLinuxCtrl+Shift+M.

Fix from the Problems panel

Open the Problems panelOpen the Problems panelOpen the Diagnostics panelOpen the Problems tool windowCtrl+Shift+MmacOSCmd+Shift+MWindowsCtrl+Shift+MLinuxCtrl+Shift+M to see every diagnostic across the page in one list, not just the ones currently in view. Selecting an entry jumps to it in the editor; fixing it and saving clears the entry immediately, so you can work through a page systematically instead of scrolling around hunting for underlines.

Where to go next