Developing md2pdf

Table of Contents

Installing Prerequisites

Windows

  1. Copy the following text:

    Set-ExecutionPolicy Bypass -Scope Process -Force
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072
iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

  2. Press Win. An interface should pop up as shown below:

    1

  3. Search for settings by typing "Settings" in the text field as shown below:

    2

    Press Enter.

  4. A window should pop up as shown below:

    3

    Press "Apps" in the selection below.

  5. You should be redirected to "Apps & Features" as shown below:

    4

    Below the subtitle "Apps & Features", press the hyperlink "App execution aliases".

  6. You should be redirected to "App execution aliases" as shown below:

    5

    Turn off the "App installer" for both "python.exe" and "python3.exe". Afterwards, exit the settings app.

  7. Press Windows + R (Press Windows and R keys simultaneously)

  8. A window with a title Run should appear. Focus to the said window in the Open: text field by hovering the mouse towards the said text field and left-clicking the mouse and type powershell as shown below:

  9. Press Ctrl + Shift + Enter (Press Ctrl, Shift, and Enter keys simultaneously).

  10. A window with a title User Account Control should appear as shown below:

  11. Focus to the said window and press the Yes button by hovering the mouse towards the said button and left-clicking the mouse. A window named Administrator: Windows Powershell should pop-up.

  12. Focus to the window named Administrator: Windows Powershell window by hovering the mouse towards the said window and left-clicking the mouse. Then, press Ctrl + V (Press Ctrl and V keys simultaneously), and Enter afterwards.

    If the window Administrator: Windows Powershell seems to hang up, focus to said window by hovering the mouse towards the said window and left-clicking the mouse, then press Enter five times every minute or so until something happens.

  13. Restart your computer, then login to the user account to which you have done the above instructions at.

  14. Copy the following text:

    choco install -y just nodejs python
npm install katex

    Then, repeat step 7-12.

  15. [RECOMMENDED] Change directory to desired one

    It is recommended to change directory to where you want to fiddle around with the project at, by copying the following text, and replacing the <dir> in said text to your desired directory in your machine:

    cd <dir>

    Afterwards, repeat step 12.

  16. Copy the following text:

    git clone https://github.com/whinee/md2pdf

    Afterwards, repeat step 12.

  17. Copy the following text:

    just bootstrap

    Afterwards, repeat step 12.

  18. Every time you open the terminal, copy the following text

    just dev

    Afterwards, repeat step 12. It should give you instructions on what to do.

Congratulations, you are now ready to develop md2pdf! For contribution guidelines, visit this link.

Mac

  1. Open your preferred terminal and run the following command:

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

  2. Next, for OS X 10.13 (High Sierra) or younger, run the following command:

    echo 'export PATH="/usr/local/opt/python/libexec/bin:$PATH"' >> ~/.profile

    And for OS X 10.12 (Sierra) or older, use the following command instead:

    echo 'export PATH=/usr/local/bin:/usr/local/sbin:$PATH' >> ~/.profile

  3. Afterwards, install the rest of the prerequisites by running the following command:

    brew install just node python

  4. Then, install katex with npm by running the following command:

    npm install katex

  5. [RECOMMENDED] Change directory to desired one

    It is recommended to change directory to where you want to fiddle around with the project at, by replacing the <dir> in the following text to your desired directory in your machine, and running it as a command:

    cd <dir>

  6. Clone the repository by running the following command:

    git clone https://github.com/whinee/md2pdf

  7. Finally, bootstrap your development environment by running the following command:

    just bootstrap

  8. Every time you open the terminal, run the following command:

    just dev

    It should give you instructions on what to do.

Congratulations, you are now ready to develop md2pdf! For contribution guidelines, visit this link.

Linux

Debian

  1. Open your preferred terminal and run the following command to install the prerequisites:

    curl -q 'https://proget.makedeb.org/debian-feeds/prebuilt-mpr.pub' | gpg --dearmor | sudo tee /usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg 1> /dev/null
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/prebuilt-mpr-archive-keyring.gpg] https://proget.makedeb.org prebuilt-mpr $(lsb_release -cs)" | sudo tee /etc/apt/sources.list.d/prebuilt-mpr.list
sudo apt update -y
sudo apt install -y just nodejs python3-pip

  2. Then, install katex with npm by running the following command:

    npm install katex

  3. [RECOMMENDED] Change directory to desired one

    It is recommended to change directory to where you want to fiddle around with the project at, by replacing the <dir> in the following text to your desired directory in your machine, and running it as a command:

    cd <dir>

  4. Clone the repository by running the following command:

    git clone https://github.com/whinee/md2pdf

  5. Finally, bootstrap your development environment by running the following command:

    just bootstrap

  6. Every time you open the terminal, run the following command:

    just dev

    It should give you instructions on what to do.

Congratulations, you are now ready to develop md2pdf! For contribution guidelines, visit this link.

Arch

  1. Open your preferred terminal and run the following command to install the prerequisites:

    sudo pacman -Syyu --noconfirm just nodejs python

  2. Then, install katex with npm by running the following command:

    npm install katex

  3. [RECOMMENDED] Change directory to desired one

    It is recommended to change directory to where you want to fiddle around with the project at, by replacing the <dir> in the following text to your desired directory in your machine, and running it as a command:

    cd <dir>

  4. Clone the repository by running the following command:

    git clone https://github.com/whinee/md2pdf

  5. Finally, bootstrap your development environment by running the following command:

    just bootstrap

  6. Every time you open the terminal, run the following command:

    just dev

    It should give you instructions on what to do.

Congratulations, you are now ready to develop md2pdf! For contribution guidelines, visit this link.