[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"project-10126":3},{"id":4,"name":5,"fullName":6,"owner":5,"repo":5,"description":7,"homepage":8,"htmlUrl":9,"language":10,"languages":9,"totalLinesOfCode":9,"stars":11,"forks":12,"watchers":13,"openIssues":14,"contributorsCount":15,"subscribersCount":15,"size":15,"stars1d":16,"stars7d":17,"stars30d":18,"stars90d":15,"forks30d":15,"starsTrendScore":19,"compositeScore":20,"rankGlobal":9,"rankLanguage":9,"license":21,"archived":22,"fork":22,"defaultBranch":23,"hasWiki":22,"hasPages":22,"topics":24,"createdAt":9,"pushedAt":9,"updatedAt":42,"readmeContent":43,"aiSummary":44,"trendingCount":15,"starSnapshotCount":15,"syncStatus":45,"lastSyncTime":46,"discoverSource":47},10126,"Zettlr","Zettlr\u002FZettlr","Your One-Stop Publication Workbench","https:\u002F\u002Fwww.zettlr.com",null,"TypeScript",13093,795,93,500,0,9,26,124,34,43.7,"GNU General Public License v3.0",false,"develop",[25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41],"desktop","docx","electron","html","languages","libreoffice","linux","macos","markdown","nodejs","office","offline","pandoc","pdf","productivity","windows","zettlr","2026-06-12 02:02:17","\u003Ch1 align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FZettlr\u002FZettlr\">\n    \u003Cimg src=\"https:\u002F\u002Fraw.githubusercontent.com\u002FZettlr\u002FZettlr\u002Fmaster\u002Fresources\u002Ficons\u002Fpng\u002F256x256.png\" alt=\"Zettlr\"\u002F>\n  \u003C\u002Fa>\n  \u003Cbr\u002F>\n  Zettlr [\u003Cem>ˈset·lər\u003C\u002Fem>]\n\u003C\u002Fh1>\n\n\u003Cp align=\"center\">\u003Cstrong>Your One-Stop Publication Workbench\u003C\u002Fstrong>.\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fdoi.org\u002F10.5281\u002Fzenodo.2580173\">\n    \u003Cimg src=\"https:\u002F\u002Fzenodo.org\u002Fbadge\u002FDOI\u002F10.5281\u002Fzenodo.2580173.svg\" alt=\"DOI\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fwww.gnu.org\u002Flicenses\u002Fgpl-3.0\">\n    \u003Cimg src=\"https:\u002F\u002Fimg.shields.io\u002Fbadge\u002FLicense-GPLv3-blue.svg\" alt=\"License: GNU GPL v3\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fwww.zettlr.com\u002Fdownload\">\n    \u003Cimg alt=\"GitHub tag (latest by date)\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Ftag-date\u002FZettlr\u002FZettlr.svg?label=latest\">\n  \u003C\u002Fa>\n  \u003Cimg alt=\"GitHub All Releases\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fdownloads\u002FZettlr\u002FZettlr\u002Ftotal.svg\">\n  \u003Cimg alt=\"Unit Tests \u002F Lint\" src=\"https:\u002F\u002Fgithub.com\u002FZettlr\u002FZettlr\u002Factions\u002Fworkflows\u002Fcheck.yml\u002Fbadge.svg\">\n  \u003Cimg alt=\"Build\" src=\"https:\u002F\u002Fgithub.com\u002FZettlr\u002FZettlr\u002Fworkflows\u002FBuild\u002Fbadge.svg\">\n\u003C\u002Fp>\n\n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fwww.zettlr.com\u002F\" target=\"_blank\">Homepage\u003C\u002Fa> |\n  \u003Ca href=\"https:\u002F\u002Fwww.zettlr.com\u002Fdownload\">Download\u003C\u002Fa> |\n  \u003Ca href=\"https:\u002F\u002Fdocs.zettlr.com\u002F\" target=\"_blank\">Documentation\u003C\u002Fa> |\n  \u003Ca href=\"https:\u002F\u002Fforum.zettlr.com\u002F\" target=\"_blank\">Community Forum\u003C\u002Fa> |\n  \u003Ca href=\"https:\u002F\u002Fgo.zettlr.com\u002Fdiscord\" target=\"_blank\">Discord\u003C\u002Fa> |\n  \u003Ca href=\"#contributing\">Contributing\u003C\u002Fa> |\n  \u003Ca href=\"https:\u002F\u002Fzettlr.com\u002Fsupporters\" target=\"_blank\">Support Us\u003C\u002Fa> |\n  \u003Ca rel=\"me\" href=\"https:\u002F\u002Ffosstodon.org\u002F@zettlr\" target=\"_blank\">Mastodon\u003C\u002Fa>\n\u003C\u002Fp>\n\n![screenshot](\u002Fresources\u002Fscreenshots\u002Fzettlr_view.png)\n\nZettlr brings simplicity back to your texts. Open-minded writing that adapts to your style. Fast information retrieval that finds what matters to you. Versatile exporting that enables you to adapt to whatever publication pipeline your employer or school uses.\n\nFocus on what matters to you.\n\n**Publish, not perish.**\n\n> [Learn more on our website](https:\u002F\u002Fzettlr.com\u002F).\n\n***\n\n**Table of Contents**\n\n- [Features](#features)\n- [Setup](#setup)\n- [Getting Started](#getting-started)\n- [Building from Source](#building-from-source)\n- [Contributing](#contributing)\n  - [Translating](#translating)\n  - [Contributing Code](#contributing-code)\n  - [What Should I Know To Contribute Code?](#what-should-i-know-to-contribute-code)\n  - [Development Commands](#development-commands)\n  - [Build Flags](#build-flags)\n  - [Directory Structure](#directory-structure)\n  - [On the Distinction between Modules and Service Providers](#on-the-distinction-between-modules-and-service-providers)\n  - [The Application Lifecycle](#the-application-lifecycle)\n- [Command-Line Switches](#command-line-switches)\n- [VSCode Extension Recommendations](#vscode-extension-recommendations)\n- [License](#license)\n\n## Features\n\n- Your Notes are your notes: Zettlr is **privacy-first**\n- **Citations** made easy: Tight and ever-growing integration with your favourite reference manager (Zotero, JabRef, and many others)\n- Available in over a **dozen languages**\n- Draft your publications in a professional environment, with **LaTeX and Word template support**\n- Simple and beautiful exports with [Pandoc](https:\u002F\u002Fpandoc.org\u002F), [LaTeX](https:\u002F\u002Fwww.latex-project.org\u002F), and [Textbundle](http:\u002F\u002Ftextbundle.org\u002F)\n- **Snippets** allow you to automate insertion of boilerplate code\n- Themes, dark modes, and full flexibility with **custom CSS**\n- **Code highlighting** for many languages\n- Support for state of the art knowledge management techniques (**Zettelkasten**)\n- A powerful **full text search** that helps you find anything, anywhere\n\n… and the best is: **Zettlr is [Free and Open Source Software (FOSS)](https:\u002F\u002Fen.wikipedia.org\u002Fwiki\u002FFree_and_open-source_software)!**\n\n## Setup\n\nTo install Zettlr, just [download the latest release](https:\u002F\u002Fwww.zettlr.com\u002Fdownload\u002F) for your operating system. Currently supported are macOS, Windows, and most Linux distributions.\n\nOn our website and here on GitHub, we provide a set of installers for the most common use-cases. We provide both 64-bit installers as well as installers for ARM systems (called \"Apple Silicon\" in the macOS ecosystem). 32-bit is not supported. We offer the following binaries directly:\n\n* macOS (Intel and Apple Silicon)\n* Windows (x64)\n* Debian\u002FUbuntu (x64 and ARM) \n* Fedora\u002FRed Hat (x64 and ARM)\n* AppImage (x64 and ARM)\n\nThanks to our community, we can also offer you a variety of other setup opportunities via package managers:\n\n* [Homebrew (macOS)](https:\u002F\u002Fformulae.brew.sh\u002Fcask\u002Fzettlr)\n* [Aptitude (Ubuntu\u002FDebian)](https:\u002F\u002Fapt.zettlr.com)\n* [Flathub (Linux)](https:\u002F\u002Fflathub.org\u002Fapps\u002Fdetails\u002Fcom.zettlr.Zettlr)\n* [Chocolatey (Windows)](https:\u002F\u002Fcommunity.chocolatey.org\u002Fpackages\u002Fzettlr\u002F)\n* [Arch Linux](https:\u002F\u002Fwiki.archlinux.org\u002Ftitle\u002FZettlr)\n\nAll other [platforms that Electron supports](https:\u002F\u002Fwww.electronjs.org\u002Fdocs\u002Flatest\u002Fdevelopment\u002Fbuild-instructions-gn#platform-prerequisites) are supported as well, but you will need to build the app yourself for this to work.\n\n**Please also consider supporting the development with a donation. You can donate once, or monthly. [Learn more on our website](https:\u002F\u002Fwww.zettlr.com\u002Fsupporters). Thank you!**\n\n## Getting Started\n\nAfter you have installed Zettlr, [head over to our documentation](https:\u002F\u002Fdocs.zettlr.com\u002F) to get to know Zettlr. Refer to the [Quick Start Guide](https:\u002F\u002Fdocs.zettlr.com\u002Fen\u002F5-minutes\u002F), if you prefer to use software heads-on.\n\n![The central window of Zettlr using the dark theme](\u002Fresources\u002Fscreenshots\u002Fzettlr_view_dark.png)\n\n## Building from Source\n\nYou can compile the app for yourself, if you prefer. To do so, refer to our development guide below to ensure you have all required dependencies installed. Then, you can build the app for your computer using the command `yarn package`.\n\n## Contributing\n\nAs an Open Source application, Zettlr always welcomes contributions from the community. **You do not need to know how to write code to help!** A full overview over all the areas where you can help can be found in our [contributing guide](.\u002FCONTRIBUTING.md). Here, we introduce you to the two biggest areas where we welcome help: translations and contributing code.\n\n### Translating\n\nThe development team maintains the English and German translations, but lacks adequate knowledge of other languages. All the other available translations have been created by our community.\n\nZettlr's translations utilize the [gettext system](https:\u002F\u002Fwww.gnu.org\u002Fsoftware\u002Fgettext\u002F). This means that the translations are kept in PO-files within the [`static\u002Flang` directory](.\u002Fstatic\u002Flang).\n\nTo update a translation, simply download the corresponding language file and edit it. You can edit PO-files with a simple text editor, but if you prefer a more comfortable graphical editor, there are many out there. One good option is the Open Source editor [POedit](https:\u002F\u002Fpoedit.net\u002F).\n\nAs soon as you are happy with your changes, open a Pull Request here that updates the corresponding file. GitHub has created a great [guide on how to open Pull Requests](https:\u002F\u002Fdocs.github.com\u002Fen\u002Frepositories\u002Fworking-with-files\u002Fmanaging-files\u002Fediting-files#editing-files-in-another-users-repository).\n\n### Contributing Code\n\nZettlr is an [Electron](https:\u002F\u002Fwww.electronjs.org\u002F)-based app, so to start developing, you'll need to have the following installed on your computer:\n\n1. [NodeJS](https:\u002F\u002Fnodejs.org\u002F). Make sure it's at least Node 22 (`lts\u002Fjod`). To test what version you have, run `node -v`.\n2. [Yarn](https:\u002F\u002Fyarnpkg.com\u002Fen\u002F). This is the package manager for the project, as we do not commit `package-lock.json`-files and many commands require yarn. You can install this globally using `npm install -g yarn` or Homebrew, if you are on macOS.\n3. On Windows, we recommend to [install the Windows Subsystem for Linux (WSL)](https:\u002F\u002Flearn.microsoft.com\u002Fen-us\u002Fwindows\u002Fwsl\u002Finstall), which will make many of the next steps easier.\n4. A few command-line utilities that various scripts require for running the development builds:\n    * [`cURL`](https:\u002F\u002Fcurl.se\u002Fdownload.html) (required by the Pandoc download script)\n    * `unzip` (required by the Pandoc download script)\n    * [`jq`](https:\u002F\u002Fjqlang.github.io\u002Fjq\u002F) (required by the i18n script)\n5. An appropriate build toolchain for your operating system, since Zettlr requires a few native C++-modules that must be compiled before running the app:\n    * **macOS**: On macOS, installing the XCode command-line tools via `xcode-select --install` suffices\n    * **Windows**: On Windows, you'll need the [free Visual Studio development tools](https:\u002F\u002Fvisualstudio.microsoft.com\u002Ffree-developer-offers\u002F) that include the required tools\n    * **Linux**: On Linux, there are a variety of compatible toolchains available, sometimes they are already preinstalled. Refer to your distribution's manual for more information.\n\nThen, simply clone the repository and install the dependencies on your local computer:\n\n```bash\n$ git clone https:\u002F\u002Fgithub.com\u002FZettlr\u002FZettlr.git\n$ cd Zettlr\n$ yarn install --immutable\n```\n\nThe `--immutable` flag ensures that yarn will stick to the versions as listed in the `yarn.lock` and not attempt to update them.\n\nDuring development, hot module reloading (HMR) is active so that you can edit the renderer's code easily and hit `F5` after the changes have been compiled by `electron-forge`. You can keep the developer tools open to see when HMR has finished loading your changes.\n\n### What Should I Know To Contribute Code?\n\nIn order to provide code, you should have basic familiarity with the following topics and\u002For manuals (ordered by descending importance):\n\n* [JavaScript](https:\u002F\u002Fdeveloper.mozilla.org\u002Fen-US\u002Fdocs\u002FWeb\u002FJavaScript) (especially asynchronous code) and [TypeScript](https:\u002F\u002Fwww.typescriptlang.org\u002Fdocs\u002F)\n* [Node.js](https:\u002F\u002Fnodejs.org\u002Fapi\u002F)\n* [Electron](https:\u002F\u002Fwww.electronjs.org\u002Fdocs)\n* [Vue.js 3.x](https:\u002F\u002Fvuejs.org\u002Fguide\u002Fintroduction.html) and [Pinia](https:\u002F\u002Fpinia.vuejs.org\u002F)\n* [CodeMirror 6.x](https:\u002F\u002Fcodemirror.net\u002Fdocs\u002F)\n* [ESLint](https:\u002F\u002Feslint.org\u002F)\n* [LESS](https:\u002F\u002Flesscss.org\u002F#)\n* [Webpack 5.x](https:\u002F\u002Fwebpack.js.org\u002Fconcepts\u002F)\n* [Electron forge](https:\u002F\u002Fwww.electronforge.io\u002F)\n* [Electron builder](https:\u002F\u002Fwww.electron.build\u002F)\n\n> [!TIP]\n> See the \"Directory Structure\" section below to get an idea of how Zettlr specifically works.\n\n### Development Commands\n\nThis section lists all available commands that you can use during application development. These are defined within the `package.json` and can be run from the command line by prefixing them with `yarn`. Run them from within the base directory of the repository.\n\n#### `start`\n\nUse this command to carefree test any changes you make to the application. This command will start the application, but will provide a custom configuration and a custom directory. Thus, it will not touch any files that a regular Zettlr installation will use.\n\n**The first time you start this command**, pass the `--clean`-flag to copy a bunch of test-files to your `.\u002Fresources`-directory, create a `test-config.yml` in your project root, and start the application with this clean configuration. Then, you can adapt the `test-config.yml` to your liking (so that certain settings which you would otherwise _always_ set will be pre-set without you having to open the preferences).\n\nWhenever you want to reset the test directory to its initial state (or you removed the directory, or cloned the whole project anew), pass the flag `--clean` to the command in order to create or reset the directory. **This is also necessary if you changed something in `test-config.yml`**.\n\nIf you want to prevent a config-file from being created (e.g., to simulate the first start experience), you can pass the flag `--no-config` to this command.\n\nYou can pass additional command-line switches such as `--clear-cache` to this command as well. They will be passed to the child process.\n\n> [!WARNING]\n> Attention: Before first running the command, you **must** run it with the `--clean`-flag to create the directory in the first place!\n\nAdditionally, have a look at our [full development documentation](https:\u002F\u002Fdocs.zettlr.com\u002Fen\u002Fget-involved).\n\n#### `package`\n\nPackages the application, but not bundle it into an installer. Without any suffix, this command will package the application for your current platform and architecture. To create specific packages (may require running on the corresponding platform), the following suffixes are available:\n\n- `package:mac-x64` (Intel-based Macs)\n- `package:mac-arm` (Apple Silicon-based Macs)\n- `package:win-x64` (Intel-based Windows)\n- `package:linux-x64` (Intel-based Linux)\n- `package:linux-arm` (ARM-based Linux)\n\nThe resulting application packages are stored in `.\u002Fout`.\n\n> [!IMPORTANT]\n> This command will skip typechecking to speed up builds, so we recommend running `lint` before packaging to ensure that there are no errors.\n\n#### `release:{platform-arch}`\n\nPackages the application and then bundles it into an installer for the corresponding platform and architecture. To create such a bundle (may require running on the corresponding platform), one of the following values for `{platform-arch}` is required:\n\n- `release:mac-x64` (Intel-based Macs)\n- `release:mac-arm` (Apple Silicon-based Macs)\n- `release:win-x64` (Intel-based Windows)\n- `release:linux-x64` (Intel-based Linux)\n- `release:linux-arm` (ARM-based Linux)\n\nThe resulting setup bundles are stored in `.\u002Frelease`.\n\n> [!NOTE]\n> While you can `package` directly for your platform without any suffix, you need to specify the platform and architecture when creating a release bundle, since electron-builder would otherwise include the development-dependencies in the `app.asar`, resulting in a bloated application.\n\n#### `csl:refresh`\n\nThis downloads the [Citation Style Language](https:\u002F\u002Fcitationstyles.org\u002F) (CSL) files with which the application is shipped, and places them in the `static\u002Fcsl-locales`- and `static\u002Fcsl-styles`-directories respectively.\n\n> [!NOTE]\n> This command is intended for an automated workflow that runs from time to time on the repository to perform this action. **Do not commit updated files to the repository**. Instead, the updated files will be downloaded whenever you `git fetch`.\n\n#### `lint:code`\n\nRuns [ESLint](https:\u002F\u002Feslint.org\u002F) over the codebase. Apps such as [Visual Studio Code](https:\u002F\u002Fcode.visualstudio.com\u002F) will automatically run ESLint in the background on your open files. This command runs it across the entire code base.\n\n> [!TIP]\n> Usually, you will want to run the `lint` command instead.\n\n#### `lint:types`\n\nRuns TypeScript's type checker via [`vue-tsc`](https:\u002F\u002Fwww.npmjs.com\u002Fpackage\u002Fvue-tsc) over the codebase. Apps such as [Visual Studio Code](https:\u002F\u002Fcode.visualstudio.com\u002F) will automatically check types for your open files in the background. This command checks the entire code base.\n\n> [!TIP]\n> Usually, you will want to run the `lint` command instead.\n\n#### `lint`\n\nRuns both `lint:code` and `lint:types` in one go. This ensures that any code you add conforms to stylistic rules and can run without obvious errors. Make sure to run this command prior to submitting a Pull Request.\n\n> [!NOTE]\n> This command will run automatically on each Pull Request to check your code for inconsistencies.\n\n#### `lint:po`\n\nThis command ensures all translation files in the directory `static\u002Flang` can be parsed by the app. It does so by parsing them with the `gettext` parser that ships with Zettlr. This command does not require the `gettext` system itself to be installed on the machine, as it only uses the Node module.\n\n> [!NOTE]\n> This command will run automatically on pull requests that touch `*.po`-files.\n\n#### `shortcut:install`\n\nCreates a `.desktop`-file into your applications which enables you to quickly start an app that you have compiled from source. This requires Linux. To use new changes, simple sync the repository, run `package` again, and you're good to go.\n\n> [!WARNING]\n> We provide this command as a convenience. Unless you know what you are doing, you should not run code directly compiled from the HEAD commit of the develop branch. This command *can* be useful, however, in a few instances where you know what may go wrong and can take appropriate precautions.\n\n#### `shortcut:uninstall`\n\nRemoves the `.desktop`-file created by `shortcut:install`.\n\n> [!NOTE]\n> You don't have to uninstall and reinstall the shortcut whenever you compile the binary anew. Just make sure that Zettlr is closed before you recompile it. You should only have to reinstall the shortcut if the template (in `scripts\u002Fassets\u002Fzettlr-dev.desktop`) has changed.\n\n#### `test`\n\nThis runs the unit tests in the directory `.\u002Ftest`. Make sure to run this command prior to submitting a Pull Request, as this will be run every time you commit to the PR, and this way you can make sure that your changes don't break any tests, making the whole PR-process easier.\n\n#### `test-gui`\n\nSee `start`.\n\n> [!IMPORTANT]\n> This command is deprecated and only an alias for `start`. Use `start` instead.\n\n### Build Flags\n\nThe build process of Zettlr supports build flags that you can use to hardwire\ncertain behaviors into the final binary. These usually come as environment\nvariables. If they are present, Zettlr will produce a different binary.\n\n#### `ZETTLR_DISABLE_UPDATE_CHECK`\n\nIf this environment variable is present during build, this will cause the resulting binary to have its built-in update-checking mechanism disabled. This is useful if you are repackaging the app for distribution through a package manager. The build script will emit a warning that the binary will not have update checks enabled.\n\nTo disable the update check at build time, simply make sure that this environment variable is present. The build script only checks for its presence, not the actual value. To ensure you are including the update check mechanism, make sure this environment variable is *not* set, e.g., by running `unset ZETTLR_DISABLE_UPDATE_CHECK` before running the build script.\n\n> [!CAUTION]\n> By creating and distributing a version of Zettlr with update checks disabled, you are responsible for ensuring that users will receive updates for Zettlr through a different mechanism. You acknowledge that you are responsible for ensuring that your update mechanism works reliably at all times. If – for any reasons – your update mechanism is disrupted – even temporarily – and Zettlr users cannot receive new updates, you are **required** to immediately notify us of this by opening a GitHub Issue, via Discord, or via Email. **Failure to comply with these added requirements will result in our immediate termination of the implicit consent for you to distribute modified Zettlr versions. If we receive notice of a version of Zettlr being publicly distributed without a working update mechanism and you fail to communicate this directly to us, we will immediately warn users publicly about your Zettlr package and withdraw our implicit consent for you to distribute Zettlr. Thus, you will forfeit your allowance to distribute Zettlr indefinitely.** In short: Only use this build flag if you know *exactly* what you're doing, and, if something goes wrong, communicate proactively. Then, all is good.\n\n#### `BUNDLE_PANDOC`\n\nIf this environment variable is present during build, this will cause the build script to **not** bundle the correct Pandoc binary into the final application bundle. This is useful if you are repackaging the app for distribution through a package manager and ensure that Pandoc gets installed as a dependency of Zettlr. The build script will emit a warning that the binary will not be bundled with Pandoc.\n\nTo disable bundling of Pandoc, you need to set the environment variable to `0`, e.g.: `export BUNDLE_PANDOC=0`. This will cause the build script to neither download nor bundle Pandoc. (This also absolves your build environment from the specific requirements for the Pandoc download script identified above.)\n\n> [!CAUTION]\n> Zettlr users expect Pandoc to be present, since otherwise they will not be able to import or export files. Every version of Zettlr that is publicly distributed must therefore either come bundled with Pandoc, or ensure through another mechanism that Pandoc is installed on the computer. If you use this build flag while repackaging the app and distribute it via some package manager, you are **required** to ensure that Pandoc will be installed alongside Zettlr via some other means (e.g., by marking Pandoc as a dependency of Zettlr). We do not want users to start complaining that some Zettlr version has non-functioning exports or imports. **Failure to comply with these added requirements will result in our immediate termination of the implicit consent for you to distribute modified Zettlr versions. Thus, you will forfeit your allowance to distribute Zettlr indefinitely.** In short: Only use this build flag if you know *exactly* what you're doing. Then, all is good.\n\n### Directory Structure\n\nZettlr is a mature app that has amassed hundreds of directories over the course of its development. Since it is hard to contribute to an application without any guidance, we have compiled a short description of the directories with how they interrelate.\n\n\u003C!-- File tree generated with `tree -d -L 4 -I node_modules .` in root -->\n\n```\n.\n├── out                         # Contains unpackaged binaries after running any `package` command\n├── release                     # Contains distributables after running any `release` command\n├── resources                   # General resource files\n│   ├── NSIS                    # Windows installer bitmaps\n│   ├── icons                   # Various icon formats\n│   ├── screenshots             # Contains the main screenshots\n├── scripts                     # Scripts used during the build process and CI pipeline \n│   ├── assets                  # Assets for the script files\n│   └── test-gui                # A full file tree used with the `test-gui` command\n├── source                      # This is the actual source filetree\n│   ├── app                     # Main process components\n│   │   ├── service-providers   # Service providers that handle most of the business logic\n│   │   └── util                # Utility functions for the main process\n│   ├── common                  # Shared files between various renderer processes\n│   │   ├── img                 # Images used in various places\n│   │   ├── modules             # Shared modules\n│   │   │   ├── markdown-editor # Main Markdown editor\n│   │   │   ├── markdown-utils  # MD Utilities such as md2html converter\n│   │   │   ├── preload         # Electron preload files\n│   │   │   └── window-register # Run by every renderer during setup\n│   │   ├── util                # General utility functions\n│   │   └── vue                 # Shared Vue components\n│   ├── pinia                   # Renderer state management\n│   ├── types                   # Types-only directory; deprecated\n│   ├── win-about               # About dialog window\n│   ├── win-assets              # Assets Manager\n│   ├── win-error               # Error window\n│   ├── win-log-viewer          # Log Viewer\n│   ├── win-main                # Main window\n│   ├── win-paste-image         # Paste-Image-dialog\n│   ├── win-preferences         # Preferences window\n│   ├── win-print               # Print preview\n│   ├── win-project-properties  # Project properties\n│   ├── win-splash-screen       # The splash screen\n│   ├── win-stats               # Statistics window\n│   ├── win-tag-manager         # Tag manager\n│   └── win-update              # Updater\n├── static                      # Contains static resources\n│   ├── csl-locales             # CSL locale files\n│   ├── csl-styles              # CSL styles\n│   ├── defaults                # Default defaults\u002FPandoc profiles\n│   ├── dict                    # Dictionaries that ship with the app\n│   ├── fonts                   # Fonts that ship with the app\n│   ├── lang                    # Language and i18n-related files\n│   ├── lua-filter              # Default Lua-filters\n│   └── tutorial                # Tutorial files in various languages\n└── test                        # Unit tests\n```\n\n### On the Distinction between Modules and Service Providers\n\nYou'll notice that Zettlr contains both \"modules\" and \"service providers\". The difference between the two is simple: Service providers run in the main process and are completely autonomous while providing functionality to the app as a whole. Modules, on the other hand, provide functionality that must be triggered by user actions (e.g. the exporter and the importer).\n\n### The Application Lifecycle\n\nWhenever you run Zettlr, the following steps will be executed:\n\n0. Execute `source\u002Fmain.ts`\n1. Environment check (`source\u002Fapp\u002Flifecycle.ts::bootApplication`)\n2. Boot service providers (`source\u002Fapp\u002Flifecycle.ts::bootApplication`)\n3. Boot main application (`source\u002Fmain\u002Fzettlr.ts`)\n4. Load the file tree and the documents\n5. Show the main window\n\nAnd when you shut down the app, the following steps will run:\n\n1. Close all windows except the main window\n2. Attempt to close the main window\n3. Shutdown the main application (`source\u002Fmain\u002Fzettlr.ts::shutdown`)\n4. Shutdown the service providers (`source\u002Fapp\u002Flifecycle.ts::shutdownApplication`)\n5. Exit the application\n\nDuring development of the app (`yarn start`), the following steps will run:\n\n1. Electron forge will compile the code for the main process and each renderer process separately (since these are separate processes), using TypeScript and webpack to compile and transpile.\n2. Electron forge will put that code into the directory `.webpack`, replacing the constants you can find in the \"create\"-methods of the window manager with the appropriate entry points.\n3. Electron forge will start a few development servers to provide hot module reloading (HMR) and then actually start the application.\n\nWhenever the app is built, the following steps will run:\n\n1. Electron forge will perform steps 1 and 2 above, but instead of running the app, it will package the resulting code into a functional app package. It will also take care of producing the Linux installers.\n2. Electron builder is used to package the files into correct installers for macOS and Windows.\n\nElectron forge will put the packaged applications into the directory `.\u002Fout` while Electron builder will put the installers into the directory `.\u002Frelease`.\n\n## Command-Line Switches\n\nThe Zettlr binary features a few command line switches that you can make use of for different purposes.\n\n#### `--launch-minimized`\n\nThis CLI flag will instruct Zettlr not to show the main window on start. This is useful to create autostart entries. In that case, launching Zettlr with this flag at system boot will make sure that you will only see its icon in the tray.\n\nSince this implies the need to have the app running in the tray bar or notification area when starting the app like this, it will automatically set the corresponding setting `system.leaveAppRunning` to true.\n\n> [!NOTE]\n> This flag will not have any effect on Linux systems which do not support displaying an icon in a tray bar or notification area.\n\n#### `--clear-cache`\n\nThis will direct the File System Abstraction Layer to fully clear its cache on boot. This can be used to mitigate issues regarding changes in the code base. To ensure compatibility with any changes to the information stored in the cache, the cache is also automatically cleared when the version field in your `config.json` does not match the one in the `package.json`, which means that, as long as you do not explicitly set the `version`-field in your `test-config.yml`, the cache will always be cleared on each run when you type `yarn test-gui`.\n\n> [!TIP]\n> If you just want to casually clear the cache for troubleshooting, you can also clear the cache by selecting the appropriate menu item in the \"Help\" menu, which saves you from having to dabble with anything technical.\n\n#### `--data-dir=path`\n\nUse this switch to specify a custom data directory, which holds your configuration files. Without this switch, the data directory defaults to `%AppData%\u002FZettlr` (on Windows 10 and newer), `~\u002F.config\u002FZettlr` (on Linux), or `~\u002FLibrary\u002FApplication Support\u002FZettlr` (on macOS). The path can be absolute or relative. Basis for the relative path will be either the binary's directory (when running a packaged app) or the repository root (when running an app that is not packaged). Remember to escape spaces or quote the path, if necessary. The `~` character to denote the home directory is not expanded in this case, so make sure to pass the entire path to your home directory if necessary. Due to a minor bug in Electron, an empty `Dictionaries` subdirectory is created in the default data directory, but it does not impact functionality.\n\n#### `--disable-hardware-acceleration`\n\nThis switch causes Zettlr to disable hardware acceleration, which could be necessary in certain setups. For more information on why this flag was added, see issue [#2127](https:\u002F\u002Fgithub.com\u002FZettlr\u002FZettlr\u002Fissues\u002F2127).\n\n## VSCode Extension Recommendations\n\nThis repository makes use of Visual Studio Code's [recommended extensions feature](https:\u002F\u002Fgo.microsoft.com\u002Ffwlink\u002F?LinkId=827846). This means: If you use VS Code and open the repository for the first time, VS Code will tell you that the repository recommends to install a handful of extensions. These extensions are recommended if you work with Zettlr and will make contributing much easier. The recommendations are specified in the file `.vscode\u002Fextensions.json`.\n\nSince installing extensions is sometimes a matter of taste, we have added short descriptions for each recommended extension within that file to explain why we recommend it. This way you can make your own decision whether or not you want to install any of these extensions (for example, the SVG extension is not necessary if you do not work with the SVG files provided in the repository).\n\nIf you choose not to install all of the recommended extensions at once (which we recommend), VS Code will show you the recommendations in the extensions sidebar so you can first decide which of the ones you'd like to install and then manually install those you'd like to have.\n\n> [!TIP]\n> Using the same extensions as the core developer team will make the code generally more consistent since you will have the same visual feedback.\n\n## License\n\nThis software is licensed via the [GNU GPL v3-License](https:\u002F\u002Fwww.gnu.org\u002Flicenses\u002Fgpl-3.0.en.html).\n\nThe brand (including name, icons and everything Zettlr can be identified with) is excluded and all rights reserved. If you want to fork Zettlr to develop another app, feel free but please change name and icons. [Read about the logo usage](https:\u002F\u002Fwww.zettlr.com\u002Fpress#usage-rights).\n","Zettlr 是一个一站式的出版工作台，旨在简化文本处理流程。它支持 Markdown 语法，并集成了 Pandoc 以实现多种格式（如 DOCX、HTML、PDF 等）的导出，同时提供了强大的搜索功能和引文管理工具。该软件采用 TypeScript 开发，基于 Electron 框架，能够在 Windows、macOS 和 Linux 上运行。Zettlr 适合需要高效写作与文档管理的个人及团队使用，特别适用于学术研究、技术文档编写以及日常笔记记录等场景。",2,"2026-06-11 03:26:42","top_topic"]