SyntaxHighlighterApp

Snippet Highlighter is a web application that converts raw source codes into fancy HTML that can be used directly in your blog or anywhere you intend to drop a quick code snippet. The generated code is relatively responsive and scalable.

Turn that code snippet into a beauty!

Syntax highlighter made specifically for Developers.

📌 The Dashboard

The dashboard displays the input field, stacks, styles and advance options. Each of these categories are extremely useful in outputting a more human-driven code snippet.

📌 Stack [Languages]

The stack section within the dashboard allows you to choose any programming language of choice, this allows for flexibility over automation. We feature 500+ programming languages as provided by the Pygment library. Some of the top languages include Python, Javascript, C, C#, Java, Ruby, Kotlin, Go, Swift, PHP and so on...

🎨 Styles [Themes]

We support 50+ themes including most popular theme like monokai (a default theme for the Sublime text editor). Others include Vim, Vs, Emacs e.t.c.

🎨 Advance Options

The Dashboard houses the advance options tab and it contains series of options like:

Options	Functionality
Generator Initial Text	The initialization text for the generated HTML, Default(Yes)
Line Number	Insert line number in the generated snippet, Default(No)
Line Number Color(sub)	Line number color, trigerred when LN is toggled on, Default(Dark)
Border Color	Color of the border with Default(#5c4d5c)

📌 Border Controls

Here, you can customize the border-width which include manipulating the border-top-width, border-right-width, border-bottom-width and border-left-width.

📌 Border Radius

Here, you can customize the radius of the border, takes in value between 0 and 1 (in 'rem').

📌 Padding Controls

Here, you can customize the padding which include manipulating the padding-top-width, padding-right-width, padding-bottom-width and padding-left-width.

🎨 Color Reference

Color	Hex
Pink	#ff00cc
Blue	#24273F
Gunmetal	#022B3A
Cyan	#00ffff

🎨 Final Output [Snippet]

This shows the HTML code of your snippet, ready to be pasted into your email, blog or anywhere possible.

This shows a quick preview of the generated snippet. Comes in handy all the time.

📌 Requirements

The web app is run on Python 3.7.2, Django 3.0.8 and Pygments 2.6.1. It has been tested live on Windows.

🛠 Installation & Set Up

A0. Download or clone the repository

A1. Navigate to the root directory [directory that contains manage.py]

A2. Create a virtual environment using your terminal, activate and return to the root folder.

virtualenv MyVirtualEnviroment && cd MyVirtualEnviroment/Scripts && activate && cd ../..

1. Install packages in requirements.txt

   pip install -r requirements.txt

2. Navigate to the settings.py file and adjust the settings file like so:

   Replace:

   "contents in settings.py"

   With:

   "contents in local-settings.py"

3. Migrate & Run development server like so:

   python manage.py migrate && python manage.py runserver

Author

👤 Pius Lucky

• Github: @PiusLucky
• Official: https://www.joint-access-programmer.com

Show your support

Please ⭐️ this repository if this project helped you!

📝 License

Copyright © 2020 Pius Lucky.
This project is MIT licensed.

↥ Back To Top