Skip to content

Make your first edits

To see Zensical Studio in action, here are some instructions for creating a simple Markdown file that illustrate some of Zensical Studio's features. Copy the Markdown in the code blocks but for some examples it makes sense to type them in.

# First edit

[Hover me](https://example.com "I'm a tooltip!")

``` python
print("Hello World!")
```

Note how Zensical Studio recognizes the Markdown syntax and applies syntax highlighting to it. The precise colors depend on the color scheme your are using in your editor.

Zensical studio also helps with repeating lists. Type this in manually to see the editing support in action. Lists are automatically continued, which make producing them significantly easier.

## Lists

- bullet
- list
    - It also works
    - in indented lists.

1. Zensical Studio continues lists,
1. making this a breeze

## Todo lists

- [ ] make a first edit
- [ ] explore more

For Markdown extensions that rely on indentation like admonitions and content tabs, Zensical Studio enters the necessary spaces.

## Admonitions and content tabs

!!! tip

    For indentations to be correct, set the tab size to 4.

=== "Linux"
    Indentation is correct.

The following Markdown contains a broken link. Copy the text into a new Markdown file (e.g., test.md) in Visual Studio CodeCursorZedJetBrains IDEs and save it:

# Link validation

Zensical Studio offers [link validation](#lnk-validation) right
here in the editor.

Observe how Zensical Studio highlights the broken link caused by the anchor given in the link being mistyped.

Open the Problems panelOpen the Problems panelOpen the Diagnostics panelOpen the Problems tool windowCtrl+Shift+MmacOSCmd+Shift+MWindowsCtrl+Shift+MLinuxCtrl+Shift+M to see the list of problems in addition to the inline indications in the editor itself.

If you fix it by adding the missing 'i', you can see that the problem indicator goes away in the editor and in the Problems panelProblems panelDiagnostics panelProblems tool window.

Now add another section with a link. Type [link]( and observe how Zensical Studio begins to offer possible completions. Scroll through the list until the one you want to add is selected. You should see something like this:

beginning to type an inline triggers link completion

Continue with Preview your changes once the edit reads correctly.