coffeescript/documentation/sections/resources.md at 31ff5e41947423190cfd963267ba550ffff00a3d

mirror of https://github.com/jashkenas/coffeescript.git synced 2026-01-14 09:17:55 -05:00

Files

Geoffrey Booth e620434a2e Docs improvements: content in Markdown, organization into subtemplates, fixed tests (#4401 )

* Replace tiny bitmaps with base64-encoded URIs

* Optimize SVGs; replace logo PNG with SVG

* Modernize favicon

* Embed CSS; a bit unorthodox, but we’re a single page so there’s no point in separate .css files and their separate HTTP requests

* Documentation is now markdown, converted to HTML on compilation

* Render the examples when we’re rendering index.html; they compile so quickly that there’s no need to pre-render them and save the intermediate .js files

* Split apart index.html into components that Cakefile assembles, so that we can add in logic to include different files for v1 versus v2

* Split building index.html and building test.html into two tasks; collapse the parts of `releaseHeader` into one compact function

* Move include logic into templates

* Get error messages tests to work in the browser

* Update output index.html

* Split body into nav and body

* Watch subtemplates

* Revert "Split body into nav and body"

This reverts commit ec9e559ec0.

* Add marked

* Update gitignore

* Use idiomatic markdown output for code blocks (<pre><code>)

* Handle ids within the template, not in the Cakefile; remove marked’s auto-generated and conflicting ids

* Move the `codeFor` function into versioned folders, so that v1 and v2 docs can have different example code blocks/editors

* Update packages, including new highlight.js which supports our newer keywords and triple backticks (docs output is unchanged)

2016-12-15 21:05:44 -08:00

2.3 KiB

Raw Blame History

Resources

Source Code
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 Issues
Bug reports, feature proposals, and ideas for changes to the language belong here.
CoffeeScript Google Group
If you’d like to ask a question, the mailing list is a good place to get help.
The CoffeeScript Wiki
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, web framework plugins, and general CoffeeScript build tools.
The FAQ
Perhaps your CoffeeScript-related question has been asked before. Check the FAQ first.
JS2Coffee
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
The CoffeeScript logo is available in SVG for use in presentations.

2.3 KiB Raw Blame History Unescape Escape

Resources

2.3 KiB

Raw Blame History