Mercurial > hgrepos > Python > libs > pygments-lexer-pseudocode2

comparison README.rst @ 120:ef68b3769be5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert/rename README.md to README.rst and enhance it considerably
author Franz Glasner <fzglas.hg@dom66.de>
date Wed, 06 May 2026 15:28:25 +0200
parents README.md@5812e7f3bc13
children c90be4a80c1a
comparison
equal deleted inserted replaced
119:9be446a43b81 120:ef68b3769be5
1 .. -*- coding: utf-8 -*-
2
3 *****************************************
4 README -- Pseudocode Lexer for Pygments
5 *****************************************
6
7 This package contains Pygments lexers for some basic pseudocode.
8
9 Initially a fork of `pygments-lexer-pseudocode` it has been considerably
10 changed and expanded.
11
12 It now contains the following lexers:
13
14 .. list-table::
15 :align: left
16 :header-rows: 1
17
18 * - Name
19 - Description
20 - Extension(s)
21 - Aliases / Short Name(s)
22
23 * - AlgPseudocode
24 - Pseudocode with inspirations from CTAN's "Algpseudocodex"
25 - \*.algpseudocode, \*.algpseudo
26 - algpseudocode, algpseudo
27
28 * - AlgPseudocodeFR
29 - AlgPseudocode with french keyword expansion
30 - \*.algpseudo-fr, \*.algpseudocode-fr
31 - algpseudocode-fr, algpseudo-fr
32
33 * - AlgPseudocodeDE
34 - AlgPseudocode with german keyword expansion
35 - \*.algpseudo-de, \*.algpseudocode-de
36 - algpseudocode-de, algpseudo-de
37
38 * - FrPseudocode
39 - The original lexer (slightly changed) from `pygments-lexer-pseudocode`
40 - \*.fr-algo, \*.fr-pseudocode
41 - fr-pseudocode, fr-pseudo, fr-algorithm, fr-algo
42
43
44 Installation
45 ============
46
47 The lexers are available as a Python wheel package::
48
49 pip install pygments-lexer-pseudocode2
50
51 Alternatively, to build from the source code repository::
52
53 python -m build
54
55
56 Usage
57 =====
58
59 After installation the Pseudocode lexers automatically register itself
60 within the plugin system of Pygments. All aliases and filename extensions
61 from above are made known to Pygments.
62
63 Usage is easy.
64
65 Pygmentizing a file with a known file extension::
66
67 pygmentize document.algpseudocode
68
69 Or you can manally select the Pseudocode lexer you want to use by
70 using a command line flag::
71
72 pygmentize -l algpseudocode somefile
73
74 Within Sphinx use a lexer like this::
75
76 .. code-block:: algpseudocode
77
78
79 License
80 =======
81
82 The Pseudocode lexer is licensed under the terms of the MIT licence