
The resulting setup bundles are stored in. release:mac-arm (Apple Silicon-based Macs).The resulting application packages are stored in. package:mac-arm (Apple Silicon-based Macs).To create specific packages (may require running on the corresponding platform), the following suffixes are available: Without any suffix, this command will package the application for your current platform and architecture. Packages the application, but not bundle it into an installer. In that case, it's better to use test-gui. This means: be careful when breaking things. This will use the normal settings, so if you use Zettlr on the same computer in production, it will use the same configuration files as the regular application. Starts electron-forge, which will build the application and launch it in development mode. Run them from within the base directory of the repository. These are defined within the package.json and can be run from the command line by prefixing them with yarn. This section lists all available commands that you can use during application development. Note: See the "Directory Structure" section below to get an idea of how Zettlr specifically works. JavaScript (especially asynchronous code) and TypeScript.
ZETTLR MANUALS
In order to provide code, you should have basic familiarity with the following topics and/or manuals (ordered by importance descending): You can keep the developer tools open to see when HMR has finished loading your changes.

ZETTLR UPDATE
The -frozen-lockfile flag ensures that yarn will stick to the versions as listed in the yarn.lock and not attempt to update them.ĭuring development, hot module reloading is active so that you can edit the renderer's code easily and hit F5 after the changes have been compiled by electron-forge.
ZETTLR INSTALL
Then, simply clone the repository and install the dependencies on your local computer:

You can install this globally using npm install -g yarn or Homebrew, if you are on macOS. Yarn is the required package manager for the project, as we do not commit package-lock.json-files and many commands require yarn. To test what version you have, run node -v. Make sure it's at least Node 14 ( lts/fermium).

Please also consider becoming a patron or making a one-time donation! Getting StartedĪfter you have installed Zettlr, head over to our documentation to get to know Zettlr. To install Zettlr, just download the latest release for your operating system! Currently supported are macOS, Windows, and most Linux distributions (via Debian- and Fedora-packages as well as AppImages).Īll other platforms that Electron supports are supported as well, but you will need to build the app yourself for this to work. … and the best is: Zettlr is Open Source (FOSS)! Installation

ZETTLR FULL
