Generate minimalist code art
Report Bug
·
Request Feature
- Table of Contents
- About The Project
- Getting Started
- Usage
- Examples
- Roadmap
- License
- Contact
- Acknowledgements
Minicode is a minimalist code image generator. It allows you to create PNG or SVG images from existing code. It is based on the Pygments library which allows to detect color syntax information specific to each programming language.
This project is inspired by the work of erdavids.
Most of the variables used to generate the SVG file can be overload (more information in the Usage section).-->
To get a local copy up and running follow these simple steps.
- Clone the repo
git clone https://github.com/Gokender/minicode.git- Install PIP packages
pip install -r requirements.txtTo generate a new minimal code :
>> python minicode\cli.py
Saving file : minicode.svg
>> python minicode\cli.py --input this\is\an\example.py --output exemples\myfile
Saving file : exemples\myfile.svgIf you want to choose another language from Python (HTML for example):
>> python minicode\cli.py --lexer html
Saving file : minicode.svgTo choose a different theme :
>> python minicode\cli.py --theme monokai
Saving file : minicode.svgThe currently available themes are :
- default
- dracula
- fruity
- monokai
You can generate an image from an url. This option will override the input file variable. The --auto_size arg choose for you the best width and height.
>> python minicode\cli.py --url https://raw.githubusercontent.com/dead-beef/markovchain/master/markovchain/parser.py -a
Saving file : minicode.svgIf --png is set the output will be PNG image instead of SVG.
>> python minicode\cli.py --url https://raw.githubusercontent.com/dead-beef/markovchain/master/markovchain/parser.py -a --png
Saving file : minicode.pngIf you don't want to change the variable one by one you can update the default configuration file config.ini
Below the list of all variables you can change :
python minicode\cli.py --help
usage: cli.py [-h] [--width WIDTH] [--height HEIGHT] [--theme THEME]
[--input INPUT] [--output OUTPUT] [--code_width CODE_WIDTH]
[--code_height CODE_HEIGHT] [--start_position START_POSITION]
[--radius_rect RADIUS_RECT] [--line_spacing LINE_SPACING] [-a]
[--lexer LEXER] [--url URL] [--png]
optional arguments:
-h, --help show this help message and exit
--width WIDTH SVG width
--height HEIGHT SVG height
--theme THEME Syntax highlighting theme
--input INPUT Input filepath
--output OUTPUT Output filepath
--code_width CODE_WIDTH
Width in pixel of character
--code_height CODE_HEIGHT
Height in pixel of character
--start_position START_POSITION
Starting pixel position
--radius_rect RADIUS_RECT
Radius for rounded corner
--line_spacing LINE_SPACING
Line spacing
-a, --auto_size Choose width & height for you
--lexer LEXER Code parser
--url URL Url to download
--png Saving image in PNG
See the open issues for a list of proposed features (and known issues).
Distributed under the MIT License. See LICENSE for more information.
Gauthier Chaty - @gokender
Project Link: Minicode
- erdavids for the inspiration
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent