npm install code-prettifyAn embeddable script that makes source-code snippets in HTML prettier.
* Works on HTML pages.
* Works even if code contains embedded links, line numbers, etc.
* Simple API: include some JS & CSS and add an onload handler.
* Lightweights: small download and does not block page from loading while
running.
* Customizable styles via CSS. See the [themes gallery][1].
* Supports all C-like, Bash-like, and XML-like languages. No need to specify
the language.
* Extensible language handlers for other languages. You can specify the
language.
* Widely used with good cross-browser support. Powers https://code.google.com/
and http://stackoverflow.com/
[See an example][2].
* Include the script tag below in your document:
``HTML`
* See Getting Started to configure that URL with
options you need.
* Look at the [skin gallery][1] and pick styles that suit you.
Put code snippets in
...
or
... and it will automatically be
pretty-printed.`HTML
class Voila {
public:
// Voila
static const string VOILA = "Voila"; // will not interfere with embedded tags.
}
`FAQ
$3
The comments in
are authoritative but the lexer should work on a
number of languages including C and friends, Java, Python, Bash, SQL, HTML,
XML, CSS, JavaScript, Makefile, and Rust.It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl and
Ruby, but because of commenting conventions, doesn't work on Smalltalk, OCaml,
etc. without a language extension.
Other languages are supported via extensions:
Apollo;
Basic;
Clojure;
CSS;
Dart;
Erlang;
Go;
Haskell;
Lasso;
Lisp, Scheme;
LLVM;
Logtalk;
Lua;
MATLAB;
MLs: F#, Ocaml,SML;
Mumps;
Nemerle;
Pascal;
Protocol buffers;
R, S;
RD;
Rust;
Scala;
SQL;
Swift;
TCL;
LaTeX;
Visual Basic;
VHDL;
Wiki;
XQ;
YAML
If you'd like to add an extension for your favorite language, please look at
src/lang-lisp.js and submit a pull request.$3
You don't need to specify the language since
PR.prettyPrint() will guess.
You can specify a language by specifying the language extension along with the
prettyprint class:`HTML
The lang-* class specifies the language file extensions.
File extensions supported by default include:
"bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html", "java",
"js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh", "xhtml", "xml",
"xsl".
`You may also use the [HTML 5][3] convention of embedding a
element
inside the and using language-java style classes:`HTML
...
`$3
Yes. Prettifying obfuscated code is like putting lipstick on a pig —
i.e. outside the scope of this tool.
$3
It's been tested with IE 6, Firefox 1.5 & 2, and Safari 2.0.4. Look at
[the tests][4] to see if it works in your browser.
$3
See the changelog.
$3
Apparently wordpress does "smart quoting" which changes close quotes. This
causes end quotes to not match up with open quotes.
This breaks prettifying as well as copying and pasting of code samples. See
[WordPress's help center][5] for info on how to stop smart quoting of code
snippets.
$3
You can use the
class to turn on line numbering. If your code
doesn't start at line number 1, you can add a colon and a line number to the
end of that class as in linenums:52. For example:`HTML
>// This is line 4.
foo();
bar();
baz();
boo();
far();
faz();
$3
You can use the
class to identify a span of markup that is not code:`HTML
int x = foo(); /* This is a comment This is not code
Continuation of comment */
int y = bar();
`For a more complete example see the [issue #22 testcase][6].
$3
If you are calling
via an event handler, wrap it in a function.
Instead of doing:`JavaScript
addEventListener('load', PR.prettyPrint, false);
`wrap it in a closure like:
JavaScript
addEventListener('load', function(event) { PR.prettyPrint(); }, false);
`so that the browser does not pass an event object to
which will confuse it.$3
Prettify adds
with classes describing the kind of code. You can
create CSS styles to matches these classes.See the [theme gallery][1] for examples.
$3
Instead of
you can use a comment or processing
instructions that survives processing instructions:worksprettify.css
as explained in Getting Started.$3
Prettify puts lines into an HTML list element so that line numbers aren't
caught by copy/paste, and the line numbering is controlled by CSS in the
default stylesheet,.`The following should turn line numbering back on for the other lines:
HTML``Discussion
Please use the official [support group][7] for discussions, suggestions, and
general feedback.License
[1]: https://rawgit.com/google/code-prettify/master/styles/index.html
[2]: https://rawgit.com/google/code-prettify/master/examples/quine.html
[3]: http://dev.w3.org/html5/spec-author-view/the-code-element.html#the-code-element
[4]: https://rawgit.com/google/code-prettify/master/tests/prettify_test.html
[5]: http://wordpress.org/support/topic/125038
[6]: https://rawgit.com/google/code-prettify/master/tests/prettify_test.html#issue22
[7]: http://groups.google.com/group/js-code-prettifier