Welcome to MarkupIt's documentation!
============================================


MarkupIt is a Python-based command-line interface (CLI) application designed to easily convert markup languages. It provides a simple way to convert Markdown (GitHub Flavored Markdown) files into Typst and LaTeX formats.


Installation
------------

Prerequisites
-------------
``python`` and ``poetry`` have to be installed.

Installation
------------
To install MarkupIt, follow these steps in cloned repository:

.. code-block:: sh

   # create a virtual environment
   poetry shell

   # install the package
   poetry install

   # run the package
   markupit

Usage
-----

Once installed, you can use the ``markupit`` command to convert your Markdown files. The basic usage is as follows:

.. code-block:: sh

   # output written on screen
   markupit --from <input_format> --to <output_format> -i <input_file>

   # output written to file
   markupit --from <input_format> --to <output_format> -i <input_file> -o <output_file>

Example
-------
To convert a Markdown file named ``example.md`` to Typst and LaTeX formats:

.. code-block:: sh

   markupit --from md --to typst -i example.md -o example.typ
   markupit --from md --to latex -i example.md -o example.tex

License
-------

This project is licensed under the MIT License. See the `LICENSE <https://github.com/b0mbix/markupit/blob/main/LICENSE>`_ file for details.

Authors and contact
-------------------

This project was created on Warsaw University of Technology by students:

- Jakub Bąba <jakub.baba.stud@pw.edu.pl>
- Hubert Brzóskniewicz <hubert.brzoskniewicz.stud@pw.edu.pl>
- Nikita Sushko <nikita.sushko.stud@pw.edu.pl>

Project mentor
--------------
- `dr inż. Łukasz Neumann <https://repo.pw.edu.pl/info/author/WUT7244d020213e4e41ac349f81b7b6f3b0/%25C5%2581ukasz%2BNeumann+title?affil=IN&r=publication&lang=pl>`_


.. toctree::
   :maxdepth: 2
   :caption: Pages:

   sphinx_usage
   poetry_usage
   writers
   readers


.. toctree::
   :maxdepth: 2
   :caption: Modules:

   modules