Write¶

Zensical Studio works inside modern IDEs and code editors such as Visual Studio Code (support for other editors will be added soon). It understands Python Markdown and its extensions, the same authoring language documented in Zensical's authoring guide. That guide is the complete reference for syntax. The pages in this section show you how Zensical Studio helps you write and maintain content in your project.

Start with the basics¶

These six pages describe some basics of working with Zensical Studio in Visual Studio CodeCursorZedJetBrains IDEs:

Two more things are woven into every page rather than having one of their own:

• DiagnosticDiagnosticDiagnosticInspections are inline messages about something that needs attention. A diagnosticdiagnosticdiagnosticinspection usually appears as an underline in the Markdown source and as an item in the Problems panelProblems panelDiagnostics panelProblems tool window, so you can fix a problem immediately instead of waiting for a QA process to flag it.

• Completions suggest what you can insert next: page links and anchors, definition labels, snippet paths, or emoji and icon shortcodes. Suggestions often appear automatically; if not, use Ctrl+Space. Zensical Studio also closes common Markdown pairs as you type (an opening [ or ` gets its closing counterpart), and selecting a completion fills in a missing closing ], ), or : for you.

Workflows that cut across features¶

Some tasks are bigger than one Markdown construct. The workflow pages show how common end-to-end edits are handled in Zensical Studio when they span links, headings, reusable content, formatting, and preview. You can find these guides in the Workflows section.

If something doesn't behave as this section describes, see troubleshooting.