Workflows¶

With Zensical Studio, many tedious and repetitive tasks in technical writing are a thing of the past.

• A broken link is often one of several just like it. With the bulk repair action, you can fix them in one go.

• Formatting inconsistencies are difficult to spot. Zensical Studio's autoformatter fixes common problems in one go: it straightens tables and lists, and applies consistent indentation and spacing.

• The Python Markdown preview gives you an accurate view of how your content will be rendered. It includes snippets and, with the Directives extension, lets you preview different variants of the page.

• A generated anchor changes whenever you reword a heading. This is fine for links inside your project but can break external links. Assign a stable, explicit ID to create a stable link target for external use.

• A hand-written navigation list drifts out of sync the moment a page moves. Define an explicit nav list and Zensical Studio keeps its paths correct for you, the same way it keeps links correct.

Each of the workflow guides below walks through one such task from start to finish, the way you'd do it in a real project, and shows the effect across every file, feature, or variant it touches.

Download the example project zensical-example-project.zip, a small project with a few linked pages already in place. Unzip it, then open the folder as described in Quickstart. This is the fastest way to follow each workflow exactly as written.

• Rename or move a page without hunting down every link that pointed at it
• Keep a link from outside your project working even after you reword the heading
• Move a page and watch its navigation entry update itself
• Check each documentation variant as you write, not just after a build
• Write a warning once, safely included wherever it's needed
• Stop arguing about list markers and table alignment in review
• Flag a broken link immediately, then repair it everywhere it appears with the same click