This is the official documentation for the Zettlr Markdown Editor. This documentation describes the features Zettlr offers for writing text and organizing your files, as well as customizing your experience. In case you have not yet installed Zettlr, you can do so now by going to our download page. Zettlr is currently supported on Windows (7 or newer), macOS (10.11 or newer), and various Linux distributions. Please consult the setup instructions for platform-specific instructions on installing the application on your computer.
How to Read this Documentation¶
This documentation is structured with Zettlr's extensive feature set and target group in mind. This means that there are several patterns we follow in this documentation; both simple enumerations of certain features, and also extensive guides for more advanced and complex features.
This documentation is made of a few central categories. If you know exactly what you are looking for, the search bar at the top right is the right starting point for you. Otherwise, you can find the different explanations in these categories:
- The First Steps section contains instructions on how to set up everything necessary to start working with Zettlr. It also provides a short "getting started" guide in case you want to see what the app offers.
- A section on concepts familiarizes you with a few concepts that form the basis of how Zettlr works. It is recommended to read through these documents carefully, since Markdown editors work differently than, e.g. Microsoft Word, and it will help you avoid common pitfalls.
- The Core describes the central writing and file management feature sets of Zettlr: What it can do, how it can do it, and where you can customize it.
- Academic Tools focuses on features that are especially useful to – but not only! – students and academics.
- References contain simple enumerations on general topics (such as an explanation of all available settings or keyboard shortcuts) which serve as a quick reference for you.
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 in more languages, and improve existing ones.
- You can translate and improve this very documentation (GitHub account required).
- You can join the community on Reddit, Discord, and the forum and help new and other users.
- You can tackle open issues on GitHub and help develop the application itself.