Zettlr

(โ˜… 13,413)

Your One-Stop Publication Workbench

  • .gitattributes
  • .gitignore
  • .mocharc.js
  • .yarnrc.yml
  • CHANGELOG.md
  • CITATION.cff
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • electron-builder.yml
  • eslint.config.mjs
  • forge.config.js
  • LICENSE
  • package.json
  • README.md
  • SECURITY.md
  • tsconfig.json
  • webpack.main.config.js
  • webpack.renderer.config.js
  • webpack.rules.js
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/Zettlr/Zettlr

Downloads the entire project code from GitHub to your computer.

cd Zettlr

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn install --immutable

Downloads and installs the libraries listed in package.json.

โ”œโ”€โ”€ scripts # Various scripts; should be called via `yarn`

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation