Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/google/code-prettify

An embeddable script that makes source-code snippets in HTML prettier.
https://github.com/google/code-prettify

Last synced: about 2 months ago
JSON representation

An embeddable script that makes source-code snippets in HTML prettier.

Awesome Lists containing this project

README 

        
# Status: Archived



![status: inactive](https://img.shields.io/badge/status-inactive-red.svg)



This repository has been archived and is no longer maintained.



---



# JavaScript code prettifier



Announcement: [**Action required** *rawgit.com* is going away](https://groups.google.com/forum/#!topic/js-code-prettifier/IFHev_kLm30).



An 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].



## Setup



 * Include the script tag below in your document:

```HTML



```

 * See [Getting Started](docs/getting_started.md) to configure that URL with

   options you need.

 * Look at the [skin gallery][1] and pick styles that suit you.



## Usage



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



### For which languages does it work?



The comments in `prettify.js` 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](src/lang-apollo.js);

[Basic](src/lang-basic.js);

[Clojure](src/lang-clj.js);

[CSS](src/lang-css.js);

[Dart](src/lang-dart.js);

[Erlang](src/lang-erlang.js);

[Go](src/lang-go.js);

[Haskell](src/lang-hs.js);

[Lasso](src/lang-lasso.js);

[Lisp, Scheme](src/lang-lisp.js);

[LLVM](src/lang-llvm.js);

[Logtalk](src/lang-logtalk.js);

[Lua](src/lang-lua.js);

[MATLAB](src/lang-matlab.js);

[MLs: F#, Ocaml,SML](src/lang-ml.js);

[Mumps](src/lang-mumps.js);

[Nemerle](src/lang-n.js);

[Pascal](src/lang-pascal.js);

[Protocol buffers](src/lang-proto.js);

[R, S](src/lang-r.js);

[RD](src/lang-rd.js);

[Rust](src/lang-rust.js);

[Scala](src/lang-scala.js);

[SQL](src/lang-sql.js);

[Swift](src/lang-swift.js);

[TCL](src/lang-tcl.js);

[LaTeX](src/lang-tex.js);

[Visual Basic](src/lang-vb.js);

[VHDL](src/lang-vhdl.js);

[Wiki](src/lang-wiki.js);

[XQ](src/lang-xq.js);

[YAML](src/lang-yaml.js)



If you'd like to add an extension for your favorite language, please look at

`src/lang-lisp.js` and submit a pull request.



### How do I specify the language of my code?



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

...


```



### It doesn't work on "obfuscated code sample"?



Yes. Prettifying obfuscated code is like putting lipstick on a pig —

i.e. outside the scope of this tool.



### Which browsers does it work with?



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.



### What's changed?



See the [changelog](CHANGES.md).



### Why doesn't Prettyprinting of strings work on WordPress?



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.



### How do I put line numbers in my code?



You can use the `linenums` 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();



```



### How do I prevent a portion of markup from being marked as code?



You can use the `nocode` 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].



### I get an error message "a is not a function" or "opt_whenDone is not a function"



If you are calling `prettyPrint` 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 `PR.prettyPrint`

which will confuse it.



### How can I customize the colors and styles of my code?



Prettify adds `` with `class`es describing the kind of code.  You can

create CSS styles to matches these classes.



See the [theme gallery][1] for examples.



### I can't add classes to my code (because it comes from Markdown, etc.)



Instead of `
` you can use a comment or processing

instructions that survives processing instructions: `` works

as explained in [Getting Started](docs/getting_started.md).



### How can I put line numbers on every line instead of just every fifth line?



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, `prettify.css`.



The following should turn line numbering back on for the other lines:



```HTML



li.L0, li.L1, li.L2, li.L3,

li.L5, li.L6, li.L7, li.L8 {

  list-style-type: decimal !important;

}



```



## Discussion



Please use the official [support group][7] for discussions, suggestions, and

general feedback.



## License



[Apache License 2.0](COPYING)



[1]: https://raw.githack.com/google/code-prettify/master/styles/index.html

[2]: https://raw.githack.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://raw.githack.com/google/code-prettify/master/tests/prettify_test.html

[5]: http://wordpress.org/support/topic/125038

[6]: https://raw.githack.com/google/code-prettify/master/tests/prettify_test.html#issue22

[7]: http://groups.google.com/group/js-code-prettifier