Commit Graph

523 Commits

Author SHA1 Message Date
Geoffrey Booth
4d4839011b Merge branch '2' into async-docs 2016-11-27 19:06:24 -08:00
Gregory Huczynski
555e47dbb9 Docs for tagged template literals (#4372)
* Correct tagged template literal test.

Should use Coffeescript form of interpolated
strings, not Javascript!

* First pass at docs for tagged template literals.

* Correct alerted variable.

* Add note re checking runtime for tagged template literals

* Fixed broken example.

* Consistent style

* Clarify that CoffeeScript isn’t handling the tagged template literal, the runtime is; fix CoffeeScript spelling

* Collapse notes about generator functions and tagged template literals into the same sentence

* Make tagged template literals example into a function

* Make text less clunky.

* More clarity on what CoffeeScript is doing versus what the runtime is doing, and emphasize runtimes vs Babel/Traceur
2016-11-26 19:28:43 -08:00
Geoffrey Booth
992eb49e92 Docs for triple-backticks and escaping backticks (#4369)
* Documentation for triple backticks and escaping backticks

* Better explanation of escaped backticks within triple-backticks block
2016-11-22 22:09:35 -08:00
Geoffrey Booth
ceca091816 Relocate example per new folder structure; update per final notes 2016-11-22 21:53:03 -08:00
Geoffrey Booth
56482a3166 Docs for for…from (#4368)
* Documentation of `for...from` for iterating over generator functions

* Add note that the CoffeeScript compiler does not, in fact, generate JavaScript that runs in every JavaScript runtime 😢
2016-11-22 09:30:39 -08:00
Daniel Bayley
6c759d49bd Docs shorthand object notation (#4356)
* Docs shorthand object notation

A simple but slightly more imaginative example of shorthand object notation.

Closes #1808.

Signed-off-by: Daniel Bayley <daniel.bayley@me.com>

* Update for new documentation folder structure

* Fix typo
2016-11-20 23:04:49 -08:00
Geoffrey Booth
bc471da960 Merge branch '2' into async-docs 2016-11-20 17:20:42 -08:00
Geoffrey Booth
cc3be717a0 Docs improvements (#4367)
* The generated JavaScript for the examples in the docs ends up within index.html, so we don’t need the intermediate generated .js files committed in the repo; also, even while .gitignored they should be under `docs`, with the rest of the generated files, not under `documentation`, where the source files are.

* Add “Existential Operator” to the table of contents. Closes #4361

* Updated output due to newer version of highlight.js

* Generated the JavaScript for the docs examples should be synchronous, so that index.html isn’t generated before the JavaScript is

* In “Try CoffeeScript,” if you press the tab key it should type a tab character. Closes #3342.

* Rename doc example folders from `js` and `coffee` to just `examples`

* Add missing `yield` to the list of keywords to highlight until highlight.js catches up; update the class used to match highlight.js’ `keyword`

* `cake doc:site` should watch the example files too, not just index.html.js

* Remove examples folder, including underscore.coffee; remove link to annotated underscore.coffee
2016-11-20 17:05:19 -08:00
Geoffrey Booth
42a10ba39e Merge branch '2' into async-docs
# Conflicts:
#	Cakefile
2016-11-19 18:52:00 -08:00
Geoffrey Booth
a49c5c5150 Revert to http://coffeescript.org until GitHub pages supports HTTPS for custom domains (#4363) 2016-11-17 09:57:03 -08:00
Geoffrey Booth
7bc5b73db1 Fix links to annotated source 2016-11-15 21:37:41 -08:00
Geoffrey Booth
a95d986055 coffeescript.org goes HTTPS! 2016-11-15 21:31:53 -08:00
Geoffrey Booth
3739954de6 Move v1 documentation under docs/v1, with docs/index.html symlinking to docs/v1/index.html (with .nojekyll file to hopefully make the symlink work) 2016-11-15 20:54:30 -08:00
Geoffrey Booth
3b0b002f29 Use Google-hosted jQuery 2016-11-15 20:37:11 -08:00
Gabe
dc25f462a9 keeping it simple 2016-11-06 11:26:34 -08:00
Gabe
8b1c109b9c eliminate utterance queuing 2016-11-06 02:40:24 -08:00
Gabe
ea3f044816 refine sound example 2016-11-06 02:30:01 -08:00
Gabe
993f459880 switch to interactive sound example 2016-11-05 13:57:22 -07:00
Gabe
43e580321a change async code snippet 2016-11-05 02:54:48 -07:00
Gabe
327395d793 change async code snippet 2016-11-05 02:54:18 -07:00
Gabe
acb3c8d79c changed wording 2016-11-04 16:23:18 -07:00
Gabe
ad4a6c4877 doc fixes and updates 2016-11-04 14:20:27 -07:00
Simon Lydell
8623792bcd CoffeeScript 1.11.1 2016-10-01 20:58:53 +02:00
Simon Lydell
809634ba39 Add changelog for version 1.11.1 2016-10-01 20:55:23 +02:00
Artur Kornakov
964a588e29 Fix minor typo in changelog for 1.11.0 2016-09-26 20:37:37 +03:00
Simon Lydell
b0d8fca245 Update the changelog for 1.11.0
Fixes #4321.
2016-09-26 15:09:53 +02:00
Simon Lydell
66b5203689 CoffeeScript 1.11.0 2016-09-24 14:16:00 +02:00
Simon Lydell
e908fd4a91 Styling fixes for the documentation 2016-09-24 14:15:54 +02:00
Simon Lydell
ab97e2224e Add changelog for version 1.11.0 2016-09-24 14:15:54 +02:00
Simon Lydell
f6bc4b4c32 Update CLI flags documentation 2016-09-24 14:01:41 +02:00
Geoffrey Booth
a8b77fb4e7 Add modules documentation (#4309) 2016-09-18 20:54:44 +02:00
nvignola
f80a8a5120 Change a bad link in documentation 2016-02-29 23:00:27 +00:00
Prayag Verma
402133a50e Fix minor typo
Remove extra `the`
2016-02-03 10:52:15 +05:30
Simon Lydell
ce84924101 Fix invalid JS in one of the docs examples
Fixes #4175.
2016-01-07 08:22:59 +01:00
ven
2536bfd75c Merge pull request #4102 from casidiablo/patch-1
Fixed link to Groovy doc link
2015-09-17 17:43:31 +02:00
Cristian
4acafad07b Fixed link to Groovy doc link 2015-09-17 08:22:56 -07:00
mjhassanpur
de2db48474 Fix documentation typos 2015-09-16 21:24:53 -07:00
Michael Ficarra
8711da03a2 Merge pull request #4080 from lydell/single-newline-at-eof
Ensure that all source files end with a single `\n`
2015-09-03 20:57:39 -07:00
Jeremy Ashkenas
eb6baf2d9b Merge pull request #4083 from lydell/remove-unnecessary-files
Remove unnecessary .js files
2015-09-03 16:51:00 -04:00
Simon Lydell
ae65875c8b Remove unnecessary .js files
The example code in documentation/coffee/*.coffee accidentally had duplicate
compiled .js versions committed: Both as documentation/js/*.js and as
documentation/coffee/*.js.

The former is generated when running `cake doc:site`, while the latter has no
cake task to be generated. Removing the former and then re-compiling index.html
results in all the code examples being missing in the resulting HTML, while
removing the latter makes no difference.

In conclusion, documentation/coffee/*.js must be the unnecessary duplicates.
They are removed by this commit.
2015-09-03 22:15:45 +02:00
Simon Lydell
fcf5924dae Update date and fix formatting error in 1.10.0 changelog 2015-09-03 22:08:34 +02:00
Simon Lydell
cea773ec81 CoffeeScript 1.10.0 2015-09-03 20:10:18 +02:00
Simon Lydell
6c6c8d48bf Ensure that all source files end with a single \n
This was done by first checking all files in the repository root by hand, and
then by doing the following:

    $ npm i get-stdin@4
    $ cat clean.coffee
    fs = require 'fs'
    stdin = require 'get-stdin'

    stdin (text) ->
      for file in text.trim().split('\n')
        contents = fs.readFileSync file
          .toString().replace /\s*$/, '\n'
        fs.writeFileSync file, contents
      return
    $ ls !(node_modules)/**/*.coffee | coffee clean.coffee
2015-09-03 19:20:12 +02:00
Simon Lydell
0872c3d13d Git rid of the deprecated <tt> tag in the docs
Replaced with `<code>` tags.
2015-08-30 12:41:47 +02:00
Simon Lydell
5095e02b62 Remove unnecessary blank lines at EOF in examples
On less wide screens, where the CoffeeScript is above the JavaScript, those
lines resulted in an unnecessarily high box of CoffeeScript code.
2015-08-30 12:41:47 +02:00
Simon Lydell
874628b1d0 Improve the documentation site on smaller screens
"Smaller screens" means screens smaller than 820px wide. That's the smallest
width that the current design looks good at.

I tried to not change the current design in any way and to make as few changes
as possible.

This is what happens on smaller screens:

- The navigation bar is no longer fixed to the viewport, but always at the top
  of the page.
- The navigation bar is vertical rather than horizontal.
- CoffeeScript code is above the compiled JavaScript rather than having them
  side by side.

This allows for a larger text size, which is more compfortable to read, and no
horizontal scrolling, which many find difficult to use.
2015-08-30 12:41:36 +02:00
Simon Lydell
10aca2a38e Document destructuring defaults 2015-08-29 19:18:44 +02:00
Jeremy Ashkenas
e339f5f2da correct release date 2015-05-27 13:04:12 -04:00
Jeremy Ashkenas
c37f284771 redoc 2015-05-27 11:57:31 -04:00
Simon Lydell
b58772e8a7 CoffeeScript 1.9.3 2015-05-14 11:24:39 +02:00