⚠️ 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
tl;dr coding is cool and school is boring (also LaTeX documents just look awesome and help make something really boring a little more interesting).
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:
|Create a new document and put it in an organized folder|
|Build the last updated document into a PDF|
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:
Help, my install didn't work!
cargo command not found
kiwi command not found
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
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.