Conversation
…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.
… so that index.html isn’t generated before the JavaScript is
|
P.S. Should we remove the |
…ght.js catches up; update the class used to match highlight.js’ `keyword`
|
I like all of the improvements in this PR, and would vote for removing the examples folder (including underscore.coffee). |
…nnotated underscore.coffee
|
@lydell Okay, I’ve removed the examples, and the link to the annotated underscore.coffee. Perhaps we should create a new repo in the |
|
@jashkenas I hope you don’t mind, but I’m going to merge this in so that #4368 and #4369 can be reviewed more easily. If there’s anything in this PR you disagree with let’s discuss and I’m happy to revert/revise. I’m also happy to create a new repo under As soon as those two PRs are approved, and as soon as the docs for tagged template literals are written and approved, we can release 1.12.0. I’ve submitted some merge requests to highlight.js to fix highlighting for modules, |
|
Yeah, removing the examples sounds just fine if you like. |
|
@jashkenas Do you want to create a new repo for |
|
Nah — we can just delete it. |
* 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 jashkenas#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 jashkenas#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
3 participants
Miscellaneous improvements to the v1 docs:
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 underdocs, with the rest of the generated files, not underdocumentation, where the source files are. Ignoring the generated example files will help avoid merge conflicts between the v1 and v2 docs.I found a bug as part of working on that: the
execcall that was generating those intermediate JavaScript files was happening asynchronously, so it would really take two rounds ofcake doc:siteto get updated examples into the generatedindex.html. I changedexecto be synchronous.The existential operator section really should get its own entry in the table of contents. Closes #4361.
In “Try CoffeeScript,” if you press the tab key it should type a tab character. Currently it just changes the focus to an HTML element I can’t find, which is clearly “broken” behavior. There was a PR for this, #3342, that I used code from to implement this; plus a touch of CSS to make it pretty. #3342 was closed because people had elaborate plans for implementing CodeMirror, which never happened; until it does, I think the tab key should just work.
I also updated the output to reflect the newer version of highlight.js. My pull request highlightjs/highlight.js#1357 was accepted, so as soon as that project issues a new release it will support CoffeeScript’s newer keywords.