/KeenWrite

Primary LanguageJavaOtherNOASSERTION

Logo

A free, open-source, cross-platform desktop Markdown editor that can produce beautifully typeset PDFs.

Download

Visit KeenWrite.com for downloads.

Run

Note that the first time the application runs, it will unpack itself into a local directory. Subsequent starts will be faster.

Windows

Double-click the application to start; give the application permission to run.

Linux

Execute the following commands in a terminal:

chmod +x keenwrite.bin
./keenwrite.bin

MacOS

Execute the following commands in a terminal:

chmod +x keenwrite.app
./keenwrite.app

Java

Using Java, first follow these one-time setup steps:

  1. Download the Full version of the Java Runtime Environment, JRE 21.
    • JavaFX, which is bundled with BellSoft's Full version, is required.
  2. Install the JRE (include JRE's bin directory in the PATH environment variable).
  3. Open a new terminal.
  4. Verify the installation: java -version
  5. Download keenwrite.jar.
  6. Download keenwrite.sh.
  7. Place the .jar and .sh in the same directory.
  8. Make keenwrite.sh executable: chmod +x keenwrite.sh

Start the application as follows:

  1. Open a new terminal.
  2. Change to the .jar and .sh directory.
  3. Run: ./keenwrite.sh

The application is started.

Features

The application offers:

  • User-defined interpolated strings
  • Auto-complete variable names based on variable values
  • High-quality PDF exports
  • Real-time spell check
  • Real-time rendering of math using TeX notation
  • Real-time document statistics (with CJK word separation)
  • Diagrams: Mermaid, GraphViz, UML, sequence, timing, and more
  • Dark, custom, and responsive user interface skins
  • Integrated file manager
  • Interactive document outline
  • Internationalized font support (e.g., Chinese, Japanese, Korean)
  • Support for Pandoc's fenced div extended attribute syntax
  • R integration
  • Customizable user interface having detachable tabs
  • Platform-independent (Windows, Linux, MacOS)

Typesetting

Typesetting to PDF files requires the following:

Usage

Read the detailed documentation for using the application.

Skins

Read the skins documentation to learn about how to change the user interface appearance.

Screenshots

See screenshots for visuals.

License

This software is licensed under the BSD 2-Clause License and based on Markdown-Writer-FX.