This User Manual is the official documentation for Zettlr. Here you can find detailed descriptions for every feature and how you can tweak those to match your needs. Consult this manual any time you are stuck. You can open this manual from within the app by pressing
F1 or clicking on the menu item 'Help' → 'Open user manual' (internet connection required).
This documentation is available in several languages. You can select another language from the main landing page. Please note that these translations may be incomplete. If in doubt, always consult this (the English) version of the documentation, which is updated regularly.
If you have any questions that are not answered by this documentation, make sure to consult the Frequently Asked Questions and ask the community on Discord, GitHub Discussions, and Reddit. We also feature a YouTube channel where we occasionally upload videos on how to use the app and the associated tools.
First Steps with Zettlr¶
If you have just found Zettlr and want to get started, head over to our setup instructions to install the app on your computer. There you can also find the minimum system requirements. Additionally, this page also provides all the necessary information to fully uninstall Zettlr again, if you so wish.
How to Read this Documentation¶
This documentation utilizes a common and easy to use layout to help you find what you need quickly. On the left side, you can find the navigation panel. If you're on mobile, click the hamburger menu button to open the navigation panel.
The navigation contains all pages of this documentation. It is ordered from top to bottom. As a novice user, you can simply follow the various pages by clicking the "Next" and "Previous" buttons at the bottom of the navigation panel and each page. You can also click on an entry to jump directly to it.
If you need to look something up, you can find a search panel on the top of the navigation that helps you find the relevant sections of interest immediately.
While most of the navigation builds up gradually, you may want to take a look the references section intermittendly, since it contains various glossarys, such as a list of keyboard shortcuts, a quick reference of Markdown, and other things that are always important.
Lastly, this documentation is maintained on GitHub. If you spot an error, do not hesitate to mention it there, or directly edit the documentation pages. Each page features an "Edit on GitHub" link that brings you directly to the online editor (GitHub account required).
Zettlr is free and open source software, which means that its source code is publicly available, and the application comes at no cost. However, this also means that there is no paid staff behind the app – it is completely managed by the community. This means that we actively encourage users to get involved with the app. Depending on your skills and what you like most, there are various ways in which you can help Zettlr out:
- You can translate the app (GitHub account required).
- You can translate and improve this documentation (GitHub account required).
- You can join the community on Reddit, Discord, and GitHub Discussions and help new and other users.
- You can tackle open issues on GitHub and help develop the application itself (GitHub account required).
More information on how to get involved can be found here in the documentation.