Hana 9e216da9ef go.mod: add go.mod and move pygments to third_party
After go1.16, go will use module mode by default,
even when the repository is checked out under GOPATH
or in a one-off directory. Add go.mod, go.sum to keep
this repo buildable without opting out of the module
mode.

> go mod init github.com/mmcgrana/gobyexample
> go mod tidy
> go mod vendor

In module mode, the 'vendor' directory is special
and its contents will be actively maintained by the
go command. pygments aren't the dependency the go will
know about, so it will delete the contents from vendor
directory. Move it to `third_party` directory now.

And, vendor the blackfriday package.

Note: the tutorial contents are not affected by the
change in go1.16 because all the examples in this
tutorial ask users to run the go command with the
explicit list of files to be compiled (e.g.
`go run hello-world.go` or `go build command-line-arguments.go`).
When the source list is provided, the go command does
not have to compute the build list and whether it's
running in GOPATH mode or module mode becomes irrelevant.
2021-02-15 16:45:26 -05:00

55 lines
1.9 KiB
ReStructuredText

Welcome!
========
This is the home of Pygments. It is a generic syntax highlighter suitable for
use in code hosting, forums, wikis or other applications that need to prettify
source code. Highlights are:
* a wide range of over 300 languages and other text formats is supported
* special attention is paid to details that increase highlighting quality
* support for new languages and formats are added easily; most languages use a
simple regex-based lexing mechanism
* a number of output formats is available, among them HTML, RTF, LaTeX and ANSI
sequences
* it is usable as a command-line tool and as a library
* ... and it highlights even Perl 6!
Read more in the :doc:`FAQ list <faq>` or the :doc:`documentation <docs/index>`,
or `download the latest release <http://pypi.python.org/pypi/Pygments>`_.
.. _contribute:
Contribute
----------
Like every open-source project, we are always looking for volunteers to help us
with programming. Python knowledge is required, but don't fear: Python is a very
clear and easy to learn language.
Development takes place on `Bitbucket
<https://bitbucket.org/birkenfeld/pygments-main>`_, where the Mercurial
repository, tickets and pull requests can be viewed.
Our primary communication instrument is the IRC channel **#pocoo** on the
Freenode network. To join it, let your IRC client connect to
``irc.freenode.net`` and do ``/join #pocoo``.
If you found a bug, just open a ticket in the Bitbucket tracker. Be sure to log
in to be notified when the issue is fixed -- development is not fast-paced as
the library is quite stable. You can also send an e-mail to the developers, see
below.
The authors
-----------
Pygments is maintained by **Georg Brandl**, e-mail address *georg*\ *@*\ *python.org*.
Many lexers and fixes have been contributed by **Armin Ronacher**, the rest of
the `Pocoo <http://dev.pocoo.org/>`_ team and **Tim Hatch**.
.. toctree::
:maxdepth: 1
:hidden:
docs/index