Skip to main content

What is kiwi?

โš ๏ธ kiwi's documentation is not done โš ๏ธ

Kiwi is a tool to help you write your schoolwork (e.g. worksheets, essays, lab reports, etc) as code using LaTeX or markdown. With several automation features and a powerful template system it removes a lot of the pain points you would encounter if you tried to do it all manually. It's primarily controlled from the command line but editor extensions and a desktop app are planned for the future. Read more to see how kiwi could benefit you! Here are some core features:

  • Creating documents
  • Organizing documents
  • Writing markdown that is then transpiled (converted) to LaTeX
  • Powerful templates

Why schoolwork as code?#

tl;dr coding is cool and school is boring (also LaTeX documents just look awesome).

Introduction to the Automation#

If you try to write LaTeX manually at a large scale you will quickly realize that it is pretty repetitive. Having a tool to automatically create, organize, and build documents for you saves a ton of time and removes a ton of pain points. Kiwi can do all of this for you with only two commands:

CommandDescription
kiwi newCreate a new document and put it in an organized folder
kiwi buildBuild the last updated document into a PDF

Installing kiwi#

Using cargo you can install kiwi by running the following command in your terminal of choice:

cargo install kiwi-cli

To make sure that everything is working properly please run the following command:

kiwi --version
Help, my install didn't work!
Sorry to hear that your install didn't go smoothly! See if you have any of the problems listed below. If not, feel free to create an issue on our CLI's GitHub Repository.

cargo command not found
This means that you don't have cargo installed. Please reference cargo's installation documentation to see how to install it.
kiwi command not found
This means that kiwi is not in your $PATH. Please find where cargo installs binaries on your system. By default that would be a folder called .cargo in your home directory.

You then need the following programs installed:

  • pandoc - Converts markdown to LaTeX code
  • pdflatex - Builds a PDF from a LaTeX document
  • git - Keep track of your changes

How to learn kiwi#

The best way to learn kiwi is by using kiwi! Follow along in the documentation with a dummy project to see how kiwi works and how it can help you.