MD2CryptQR is a powerful tool that transforms your Markdown files into secure, encrypted QR codes, making it simple to share and distribute sensitive text data. The package consists of two main components: a Python-based encryptor and a web-based decryptor for quick and easy viewing.
-
To install the encryptor, first download the source code from GitHub or clone the repository.
-
Open your terminal, navigate to the encryptor-py directory, and run:
cd encryptor-py pip install -r requirements.txt
-
Option 1: Access the online version at https://ultragtx.github.io/MD2CryptQR/index.html
-
Option 2, build and serve these static files on a private HTTPS server.
cd decryptor npm install npm run build
Navigate to the folder containing your Markdown file and execute the following command:
python encryptor/main.py [OPTIONS]
Here are the available options:
-i
,--input
: (Required) Input Markdown file path.-o
,--output
: Output PDF file path. Default isoutput.pdf
.-e
,--error_correction
: Level of QR error correction. Options areL
,M
,Q
,H
. Default isL
.-l
,--qr_data_length
: The data length for each QR code. Default is700
.-c
,--compact_mode
: Enable compact mode. In this mode, The encryptor will not split the content into sections based on Markdown title syntax, and will not print titles for each section.
Example:
python encryptor/main.py -i ../README.md -o ../sample-output/output-compact.pdf -e M -l 700 -c
You can find sample PDF outputs generated using standard and compact modes in the repository, created using password "123". Click the links below to view or download them:
- Go to the web-based decryptor, either hosted on GitHub or your private HTTPS server.
- Input the password used during encryption.
- Scan each QR code in the generated document.
Special Acknowledgment A substantial portion of this project was enhanced through interactions with OpenAI's GPT-4 model. The language model aided in generating documentation, code refinement, and idea generation.
- OpenAI's GPT-4: For contributing a substantial amount of code and aiding in documentation.
Thank you for using MD2CryptQR. For further assistance, please visit our GitHub repository.