From 7a9c755e4e5d6569a632f6594c41f8693fa549e1 Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Wed, 3 May 2017 20:54:49 +0100 Subject: [PATCH] pygmentize: various tweaks (#1355) * pygmentize: various tweaks - adjust punctuation in main description and first example's description - mention "list" (rather than "show") in the -L examples, to improve memorability - explain what lexers are - clarify which of the parameters are input and output filenames - simplify last example * make -O example more didactic References: - http://pygments.org/docs/cmdline/#options-and-filters - http://pygments.org/docs/formatters/#HtmlFormatter * pygmentize: changes per code review * pygentize: fix typos --- pages/common/pygmentize.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pages/common/pygmentize.md b/pages/common/pygmentize.md index 50a0584efc..e239a8ba7d 100644 --- a/pages/common/pygmentize.md +++ b/pages/common/pygmentize.md @@ -1,27 +1,27 @@ # pygmentize -> Python based syntax highlighter. +> Python-based syntax highlighter. -- Highlight file syntax and print to standard output. Language is inferred from the file extension: +- Highlight file syntax and print to standard output (language is inferred from the file extension): `pygmentize {{file.py}}` -- Highlight syntax for a given language: +- Explicitly set the language for syntax highlighting: -`pygmentize -l {{javascript}} {{javascript_file}}` +`pygmentize -l {{javascript}} {{input_file}}` -- Show avaliable lexers: +- List available lexers (processors for input languages): `pygmentize -L lexers` - Save output to a file in HTML format: -`pygmentize -f html -o {{file.html}} {{file.py}}` +`pygmentize -f html -o {{output_file.html}} {{input_file.py}}` -- Show avaliable output formats: +- List available output formats: `pygmentize -L formatters` -- Output to HTML file with line numbers, specifying a given language: +- Output an HTML file, with additional formatter options (full page, with line numbers): -`pygmentize -f html -O linenos=1 -l {{language}} -o {{file.html}} {{file}}` +`pygmentize -f html -O "full,linenos=True" -o {{output_file.html}} {{input_file}}`