diff --git a/documentation/sections/annotated-source.md b/documentation/sections/annotated-source.md new file mode 100644 index 00000000..fc38dc3c --- /dev/null +++ b/documentation/sections/annotated-source.md @@ -0,0 +1,16 @@ +## Annotated Source + +You can browse the CoffeeScript <%= fullVersion %> source in readable, annotated form [here](http://coffeescript.org/v<%= majorVersion %>/annotated-source/). You can also jump directly to a particular source file: + +- [Grammar Rules — src/grammar](http://coffeescript.org/v<%= majorVersion %>/annotated-source/grammar.html) +- [Lexing Tokens — src/lexer](http://coffeescript.org/v<%= majorVersion %>/annotated-source/lexer.html) +- [The Rewriter — src/rewriter](http://coffeescript.org/v<%= majorVersion %>/annotated-source/rewriter.html) +- [The Syntax Tree — src/nodes](http://coffeescript.org/v<%= majorVersion %>/annotated-source/nodes.html) +- [Lexical Scope — src/scope](http://coffeescript.org/v<%= majorVersion %>/annotated-source/scope.html) +- [Helpers & Utility Functions — src/helpers](http://coffeescript.org/v<%= majorVersion %>/annotated-source/helpers.html) +- [The CoffeeScript Module — src/coffee-script](http://coffeescript.org/v<%= majorVersion %>/annotated-source/coffee-script.html) +- [Cake & Cakefiles — src/cake](http://coffeescript.org/v<%= majorVersion %>/annotated-source/cake.html) +- [“coffee” Command-Line Utility — src/command](http://coffeescript.org/v<%= majorVersion %>/annotated-source/command.html) +- [Option Parsing — src/optparse](http://coffeescript.org/v<%= majorVersion %>/annotated-source/optparse.html) +- [Interactive REPL — src/repl](http://coffeescript.org/v<%= majorVersion %>/annotated-source/repl.html) +- [Source Maps — src/sourcemap](http://coffeescript.org/v<%= majorVersion %>/annotated-source/sourcemap.html) diff --git a/documentation/sections/chat.md b/documentation/sections/chat.md index 4d82b93c..5cf3d70f 100644 --- a/documentation/sections/chat.md +++ b/documentation/sections/chat.md @@ -1,5 +1,3 @@ ## Web Chat (IRC) -Quick help and advice can usually be found in the CoffeeScript IRC room. Join `#coffeescript` on `irc.freenode.net`, or click the button below to open a webchat session on this page. - - +Quick help and advice can often be found in the CoffeeScript IRC room `#coffeescript` on `irc.freenode.net`, which you can [join via your web browser](http://webchat.freenode.net/?channels=coffeescript). diff --git a/documentation/sections/functions.md b/documentation/sections/functions.md index c1a9d19a..b094cb6e 100644 --- a/documentation/sections/functions.md +++ b/documentation/sections/functions.md @@ -6,7 +6,7 @@ Functions are defined by an optional list of parameters in parentheses, an arrow codeFor('functions', 'cube(5)') ``` -Functions may also have default values for arguments, which will be used if the incoming argument is missing (`null` or `undefined`). +Functions may also have default values for arguments, which will be used if the incoming argument is missing (`undefined`). ``` codeFor('default_args', 'fill("cup")') diff --git a/documentation/sections/resources.md b/documentation/sections/resources.md index 9e1e2927..c958b332 100644 --- a/documentation/sections/resources.md +++ b/documentation/sections/resources.md @@ -1,14 +1,6 @@ ## Resources -* [Source Code](http://github.com/jashkenas/coffeescript/)
- Use `bin/coffee` to test your changes,
- `bin/cake test` to run the test suite,
- `bin/cake build` to rebuild the CoffeeScript compiler, and
- `bin/cake build:parser` to regenerate the Jison parser if you’re working on the grammar. - - `git checkout lib && bin/cake build:full` is a good command to run when you’re working on the core language. It’ll refresh the lib directory (in case you broke something), build your altered compiler, use that to rebuild itself (a good sanity test) and then run all of the tests. If they pass, there’s a good chance you’ve made a successful change. -* [Browser Tests](v<%= majorVersion %>/test.html)
- Run CoffeeScript’s test suite in your current browser. +* [CoffeeScript on GitHub](http://github.com/jashkenas/coffeescript/) * [CoffeeScript Issues](http://github.com/jashkenas/coffeescript/issues)
Bug reports, feature proposals, and ideas for changes to the language belong here. * [CoffeeScript Google Group](https://groups.google.com/forum/#!forum/coffeescript)
@@ -17,7 +9,7 @@ If you’ve ever learned a neat CoffeeScript tip or trick, or ran into a gotcha — share it on the wiki. The wiki also serves as a directory of handy [text editor extensions](http://github.com/jashkenas/coffeescript/wiki/Text-editor-plugins), [web framework plugins](http://github.com/jashkenas/coffeescript/wiki/Web-framework-plugins), and general [CoffeeScript build tools](http://github.com/jashkenas/coffeescript/wiki/Build-tools). * [The FAQ](http://github.com/jashkenas/coffeescript/wiki/FAQ)
Perhaps your CoffeeScript-related question has been asked before. Check the FAQ first. -* [JS2Coffee](http://js2coffee.org)
+* [JS2Coffee](http://js2.coffee/)
Is a very well done reverse JavaScript-to-CoffeeScript compiler. It’s not going to be perfect (infer what your JavaScript classes are, when you need bound functions, and so on…) — but it’s a great starting point for converting simple scripts. * [High-Rez Logo](https://github.com/jashkenas/coffeescript/tree/master/documentation/images)
The CoffeeScript logo is available in SVG for use in presentations. diff --git a/documentation/sections/scripts.md b/documentation/sections/scripts.md index 572c9813..da47452d 100644 --- a/documentation/sections/scripts.md +++ b/documentation/sections/scripts.md @@ -1,4 +1,4 @@ -## "text/coffeescript" Script Tags +## `"text/coffeescript"` Script Tags While it’s not recommended for serious use, CoffeeScripts may be included directly within the browser using `