Skip to content

Update README.md. #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 11, 2017
Merged

Update README.md. #99

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,26 @@
This is a package with preferences and syntax highlighter for cutting edge
Python 3, although Python 2 is well supported, too. The syntax is compatible
with [Sublime Text](http://www.sublimetext.com), [Atom](http://atom.io) and
[Visual Studio Code](http://code.visualstudio.com).
It is meant to be a drop-in replacement for the default Python package.
[Visual Studio Code](http://code.visualstudio.com). It is meant to be a drop-in
replacement for the default Python package.

MagicPython correctly highlights all Python 3.5 and 3.6 syntax features,
including type annotations, f-strings and regular expressions. It is built
from scratch for robustness with an extensive test suite.
We are proud to say that MagicPython is used by GitHub to highlight Python.

We are proud to say that MagicPython has been included into the
[github/linguist](https://github.com/github/linguist), a library used
by GitHub.com to process languages.
**Attention VSCode users**: MagicPython is used as the _default_
Python highlighter in Visual Studio Code. Don't install it unless you
want or need the cutting edge version of it. You will likely see no
difference because you're already using MagicPython.

MagicPython correctly highlights all Python 3 syntax features,
including type annotations, f-strings and regular expressions. It is
built from scratch for robustness with an extensive test suite.

![](https://magicstack.github.io/MagicPython/example.png)

Type hints in comments require support by the color scheme. The one
Type hints in comments require support by the color scheme. The one
used in the screenshot is
[Chromodynamics](https://github.com/MagicStack/Chromodynamics).

![](https://magicstack.github.io/MagicPython/example.png)


## Installation Instructions

Expand Down