Move v1 documentation under docs/v1, with docs/index.html symlink…

…ing to `docs/v1/index.html` (with `.nojekyll` file to hopefully make the symlink work)
jashkenas · Nov 16, 2016 · 3739954 · 3739954
1 parent 3b0b002
commit 3739954
Show file tree

Hide file tree

Showing 44 changed files with 32 additions and 88 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/Cakefile b/Cakefile
@@ -171,19 +171,20 @@ task 'build:browser', 'rebuild the merged script for inclusion in the browser',
 
 
 task 'doc:site', 'watch and continually rebuild the documentation for the website', ->
+  majorVersion = CoffeeScript.VERSION.split('.')[0]
   source = 'documentation/index.html.js'
   exec 'bin/coffee -bc -o documentation/js documentation/coffee/*.coffee'
 
   do renderIndex = ->
-    codeSnippetCounter = 0
     render = _.template fs.readFileSync(source, 'utf-8')
-    fs.writeFileSync 'index.html', render
+    output = render
       codeFor: codeFor()
       releaseHeader: releaseHeader
-    log "compiled", green, "#{source}"
+    fs.writeFileSync "docs/v#{majorVersion}/index.html", output
+    log 'compiled', green, "#{source} → docs/v#{majorVersion}/index.html"
 
   fs.watchFile source, interval: 200, renderIndex
-  log "watching..." , green
+  log 'watching...' , green
 
 
 task 'doc:source', 'rebuild the internal documentation', ->

diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1 @@
+v1/index.html
diff --git a/documentation/docs/browser.html → docs/v1/annotated-source/browser.html b/documentation/docs/browser.html → docs/v1/annotated-source/browser.html
diff --git a/documentation/docs/cake.html → docs/v1/annotated-source/cake.html b/documentation/docs/cake.html → docs/v1/annotated-source/cake.html
diff --git a/documentation/docs/coffee-script.html → docs/v1/annotated-source/coffee-script.html b/documentation/docs/coffee-script.html → docs/v1/annotated-source/coffee-script.html
diff --git a/documentation/docs/command.html → docs/v1/annotated-source/command.html b/documentation/docs/command.html → docs/v1/annotated-source/command.html
diff --git a/documentation/docs/docco.css → docs/v1/annotated-source/docco.css b/documentation/docs/docco.css → docs/v1/annotated-source/docco.css
diff --git a/documentation/docs/grammar.html → docs/v1/annotated-source/grammar.html b/documentation/docs/grammar.html → docs/v1/annotated-source/grammar.html
diff --git a/documentation/docs/helpers.html → docs/v1/annotated-source/helpers.html b/documentation/docs/helpers.html → docs/v1/annotated-source/helpers.html
diff --git a/documentation/docs/index.html → docs/v1/annotated-source/index.html b/documentation/docs/index.html → docs/v1/annotated-source/index.html
diff --git a/documentation/docs/lexer.html → docs/v1/annotated-source/lexer.html b/documentation/docs/lexer.html → docs/v1/annotated-source/lexer.html
diff --git a/documentation/docs/nodes.html → docs/v1/annotated-source/nodes.html b/documentation/docs/nodes.html → docs/v1/annotated-source/nodes.html
diff --git a/documentation/docs/optparse.html → docs/v1/annotated-source/optparse.html b/documentation/docs/optparse.html → docs/v1/annotated-source/optparse.html
diff --git a/...entation/docs/public/fonts/aller-bold.eot → ...otated-source/public/fonts/aller-bold.eot b/...entation/docs/public/fonts/aller-bold.eot → ...otated-source/public/fonts/aller-bold.eot
diff --git a/...entation/docs/public/fonts/aller-bold.ttf → ...otated-source/public/fonts/aller-bold.ttf b/...entation/docs/public/fonts/aller-bold.ttf → ...otated-source/public/fonts/aller-bold.ttf
diff --git a/...ntation/docs/public/fonts/aller-bold.woff → ...tated-source/public/fonts/aller-bold.woff b/...ntation/docs/public/fonts/aller-bold.woff → ...tated-source/public/fonts/aller-bold.woff
diff --git a/...ntation/docs/public/fonts/aller-light.eot → ...tated-source/public/fonts/aller-light.eot b/...ntation/docs/public/fonts/aller-light.eot → ...tated-source/public/fonts/aller-light.eot
diff --git a/...ntation/docs/public/fonts/aller-light.ttf → ...tated-source/public/fonts/aller-light.ttf b/...ntation/docs/public/fonts/aller-light.ttf → ...tated-source/public/fonts/aller-light.ttf
diff --git a/...tation/docs/public/fonts/aller-light.woff → ...ated-source/public/fonts/aller-light.woff b/...tation/docs/public/fonts/aller-light.woff → ...ated-source/public/fonts/aller-light.woff
diff --git a/...tation/docs/public/fonts/roboto-black.eot → ...ated-source/public/fonts/roboto-black.eot b/...tation/docs/public/fonts/roboto-black.eot → ...ated-source/public/fonts/roboto-black.eot
diff --git a/...tation/docs/public/fonts/roboto-black.ttf → ...ated-source/public/fonts/roboto-black.ttf b/...tation/docs/public/fonts/roboto-black.ttf → ...ated-source/public/fonts/roboto-black.ttf
diff --git a/...ation/docs/public/fonts/roboto-black.woff → ...ted-source/public/fonts/roboto-black.woff b/...ation/docs/public/fonts/roboto-black.woff → ...ted-source/public/fonts/roboto-black.woff
diff --git a/...ion/docs/public/stylesheets/normalize.css → ...d-source/public/stylesheets/normalize.css b/...ion/docs/public/stylesheets/normalize.css → ...d-source/public/stylesheets/normalize.css
diff --git a/documentation/docs/register.html → docs/v1/annotated-source/register.html b/documentation/docs/register.html → docs/v1/annotated-source/register.html
diff --git a/documentation/docs/repl.html → docs/v1/annotated-source/repl.html b/documentation/docs/repl.html → docs/v1/annotated-source/repl.html
diff --git a/documentation/docs/rewriter.html → docs/v1/annotated-source/rewriter.html b/documentation/docs/rewriter.html → docs/v1/annotated-source/rewriter.html
diff --git a/documentation/docs/scope.html → docs/v1/annotated-source/scope.html b/documentation/docs/scope.html → docs/v1/annotated-source/scope.html
diff --git a/documentation/docs/sourcemap.html → docs/v1/annotated-source/sourcemap.html b/documentation/docs/sourcemap.html → docs/v1/annotated-source/sourcemap.html
diff --git a/documentation/css/docs.css → docs/v1/css/docs.css b/documentation/css/docs.css → docs/v1/css/docs.css
diff --git a/documentation/css/tomorrow.css → docs/v1/css/tomorrow.css b/documentation/css/tomorrow.css → docs/v1/css/tomorrow.css
diff --git a/extras/coffee-script.js → docs/v1/extras/coffee-script.js b/extras/coffee-script.js → docs/v1/extras/coffee-script.js
diff --git a/documentation/images/background.png → docs/v1/images/background.png b/documentation/images/background.png → docs/v1/images/background.png
diff --git a/documentation/images/banding.png → docs/v1/images/banding.png b/documentation/images/banding.png → docs/v1/images/banding.png
diff --git a/documentation/images/button_bg.png → docs/v1/images/button_bg.png b/documentation/images/button_bg.png → docs/v1/images/button_bg.png
diff --git a/documentation/images/button_bg_dark.gif → docs/v1/images/button_bg_dark.gif b/documentation/images/button_bg_dark.gif → docs/v1/images/button_bg_dark.gif
diff --git a/documentation/images/button_bg_green.gif → docs/v1/images/button_bg_green.gif b/documentation/images/button_bg_green.gif → docs/v1/images/button_bg_green.gif
diff --git a/documentation/images/favicon.ico → docs/v1/images/favicon.ico b/documentation/images/favicon.ico → docs/v1/images/favicon.ico
diff --git a/documentation/images/just_logo.svg → docs/v1/images/just_logo.svg b/documentation/images/just_logo.svg → docs/v1/images/just_logo.svg
diff --git a/documentation/images/logo.png → docs/v1/images/logo.png b/documentation/images/logo.png → docs/v1/images/logo.png
diff --git a/documentation/images/logo.svg → docs/v1/images/logo.svg b/documentation/images/logo.svg → docs/v1/images/logo.svg
diff --git a/documentation/images/screenshadow.png → docs/v1/images/screenshadow.png b/documentation/images/screenshadow.png → docs/v1/images/screenshadow.png
diff --git a/index.html → docs/v1/index.html b/index.html → docs/v1/index.html
@@ -5,16 +5,16 @@
   <title>CoffeeScript</title>
   <meta name="viewport" content="width=device-width, initial-scale=1" />
   <link rel="canonical" href="http://coffeescript.org" />
-  <link rel="stylesheet" type="text/css" href="documentation/css/docs.css" />
-  <link rel="stylesheet" type="text/css" href="documentation/css/tomorrow.css" />
-  <link rel="shortcut icon" href="documentation/images/favicon.ico" />
+  <link rel="stylesheet" type="text/css" href="v1/css/docs.css" />
+  <link rel="stylesheet" type="text/css" href="v1/css/tomorrow.css" />
+  <link rel="shortcut icon" href="v1/images/favicon.ico" />
 </head>
 <body>
 
   <div id="fadeout"></div>
 
   <div id="flybar">
-    <a id="logo" href="#top"><img src="documentation/images/logo.png" width="225" height="39" alt="CoffeeScript" /></a>
+    <a id="logo" href="#top"><img src="v1/images/logo.png" width="225" height="39" alt="CoffeeScript" /></a>
     <div class="navigation toc">
       <div class="button">
         Table of Contents
@@ -170,9 +170,9 @@ <h2>
 list = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
 
 math = {
-  root: <span class="built_in">Math</span>.sqrt,
-  square: square,
-  cube: <span class="function"><span class="keyword">function</span>(<span class="params">x</span>) </span>{
+  <span class="attr">root</span>: <span class="built_in">Math</span>.sqrt,
+  <span class="attr">square</span>: square,
+  <span class="attr">cube</span>: <span class="function"><span class="keyword">function</span>(<span class="params">x</span>) </span>{
     <span class="keyword">return</span> x * square(x);
   }
 };
@@ -576,23 +576,7 @@ <h2>
     </p>
     <div class='code'><pre><code><span class="function"><span class="title">fill</span> = <span class="params">(container, liquid = <span class="string">"coffee"</span>)</span> -&gt;</span>
   <span class="string">"Filling the <span class="subst">#{container}</span> with <span class="subst">#{liquid}</span>..."</span>
-</code></pre><pre><code><span class="keyword">var</span> fill;
-
-fill = <span class="function"><span class="keyword">function</span>(<span class="params">container, liquid</span>) </span>{
-  <span class="keyword">if</span> (liquid == <span class="literal">null</span>) {
-    liquid = <span class="string">"coffee"</span>;
-  }
-  <span class="keyword">return</span> <span class="string">"Filling the "</span> + container + <span class="string">" with "</span> + liquid + <span class="string">"..."</span>;
-};
-</code></pre><script>window.example3 = "fill = (container, liquid = \"coffee\") ->\n  \"Filling the #{container} with #{liquid}...\"\n"</script><div class='minibutton load' onclick='javascript: loadConsole(example3);'>load</div><div class='minibutton ok' onclick='javascript: var fill;
-
-fill = function(container, liquid) {
-  if (liquid == null) {
-    liquid = "coffee";
-  }
-  return "Filling the " + container + " with " + liquid + "...";
-};
-;alert(fill("cup"));'>run: fill("cup")</div><br class='clear' /></div>
+</code></pre><pre><code></code></pre><script>window.example3 = "fill = (container, liquid = \"coffee\") ->\n  \"Filling the #{container} with #{liquid}...\"\n"</script><div class='minibutton load' onclick='javascript: loadConsole(example3);'>load</div><div class='minibutton ok' onclick='javascript: ;alert(fill("cup"));'>run: fill("cup")</div><br class='clear' /></div>
 
     <p>
       <span id="objects_and_arrays" class="bookmark"></span>
@@ -619,49 +603,7 @@ <h2>
   sister:
     name: <span class="string">"Ida"</span>
     age:  <span class="number">9</span>
-</code></pre><pre><code><span class="keyword">var</span> bitlist, kids, singers, song;
-
-song = [<span class="string">"do"</span>, <span class="string">"re"</span>, <span class="string">"mi"</span>, <span class="string">"fa"</span>, <span class="string">"so"</span>];
-
-singers = {
-  Jagger: <span class="string">"Rock"</span>,
-  Elvis: <span class="string">"Roll"</span>
-};
-
-bitlist = [<span class="number">1</span>, <span class="number">0</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">1</span>, <span class="number">0</span>];
-
-kids = {
-  brother: {
-    name: <span class="string">"Max"</span>,
-    age: <span class="number">11</span>
-  },
-  sister: {
-    name: <span class="string">"Ida"</span>,
-    age: <span class="number">9</span>
-  }
-};
-</code></pre><script>window.example4 = "song = [\"do\", \"re\", \"mi\", \"fa\", \"so\"]\n\nsingers = {Jagger: \"Rock\", Elvis: \"Roll\"}\n\nbitlist = [\n  1, 0, 1\n  0, 0, 1\n  1, 1, 0\n]\n\nkids =\n  brother:\n    name: \"Max\"\n    age:  11\n  sister:\n    name: \"Ida\"\n    age:  9\n"</script><div class='minibutton load' onclick='javascript: loadConsole(example4);'>load</div><div class='minibutton ok' onclick='javascript: var bitlist, kids, singers, song;
-
-song = ["do", "re", "mi", "fa", "so"];
-
-singers = {
-  Jagger: "Rock",
-  Elvis: "Roll"
-};
-
-bitlist = [1, 0, 1, 0, 0, 1, 1, 1, 0];
-
-kids = {
-  brother: {
-    name: "Max",
-    age: 11
-  },
-  sister: {
-    name: "Ida",
-    age: 9
-  }
-};
-;alert(song.join(" ... "));'>run: song.join(" ... ")</div><br class='clear' /></div>
+</code></pre><pre><code></code></pre><script>window.example4 = "song = [\"do\", \"re\", \"mi\", \"fa\", \"so\"]\n\nsingers = {Jagger: \"Rock\", Elvis: \"Roll\"}\n\nbitlist = [\n  1, 0, 1\n  0, 0, 1\n  1, 1, 0\n]\n\nkids =\n  brother:\n    name: \"Max\"\n    age:  11\n  sister:\n    name: \"Ida\"\n    age:  9\n"</script><div class='minibutton load' onclick='javascript: loadConsole(example4);'>load</div><div class='minibutton ok' onclick='javascript: ;alert(song.join(" ... "));'>run: song.join(" ... ")</div><br class='clear' /></div>
     <p>
       In JavaScript, you can't use reserved words, like <code>class</code>, as properties
       of an object, without quoting them as strings. CoffeeScript notices reserved words
@@ -965,9 +907,9 @@ <h2>
 </code></pre><pre><code><span class="keyword">var</span> age, ages, child, yearsOld;
 
 yearsOld = {
-  max: <span class="number">10</span>,
-  ida: <span class="number">9</span>,
-  tim: <span class="number">11</span>
+  <span class="attr">max</span>: <span class="number">10</span>,
+  <span class="attr">ida</span>: <span class="number">9</span>,
+  <span class="attr">tim</span>: <span class="number">11</span>
 };
 
 ages = (<span class="function"><span class="keyword">function</span>(<span class="params"></span>) </span>{
@@ -1721,11 +1663,11 @@ <h2>
 </code></pre><pre><code><span class="keyword">var</span> city, futurists, name, ref, ref1, street;
 
 futurists = {
-  sculptor: <span class="string">"Umberto Boccioni"</span>,
-  painter: <span class="string">"Vladimir Burliuk"</span>,
-  poet: {
-    name: <span class="string">"F.T. Marinetti"</span>,
-    address: [<span class="string">"Via Roma 42R"</span>, <span class="string">"Bellagio, Italy 22021"</span>]
+  <span class="attr">sculptor</span>: <span class="string">"Umberto Boccioni"</span>,
+  <span class="attr">painter</span>: <span class="string">"Vladimir Burliuk"</span>,
+  <span class="attr">poet</span>: {
+    <span class="attr">name</span>: <span class="string">"F.T. Marinetti"</span>,
+    <span class="attr">address</span>: [<span class="string">"Via Roma 42R"</span>, <span class="string">"Bellagio, Italy 22021"</span>]
   }
 };
 
@@ -1802,8 +1744,8 @@ <h2>
 })();
 
 tim = <span class="keyword">new</span> Person({
-  name: <span class="string">'Tim'</span>,
-  age: <span class="number">4</span>
+  <span class="attr">name</span>: <span class="string">'Tim'</span>,
+  <span class="attr">age</span>: <span class="number">4</span>
 });
 </code></pre><script>window.example31 = "class Person\n  constructor: (options) ->\n    {@name, @age, @height = 'average'} = options\n\ntim = new Person name: 'Tim', age: 4\n"</script><div class='minibutton load' onclick='javascript: loadConsole(example31);'>load</div><div class='minibutton ok' onclick='javascript: var Person, tim;
 
@@ -3947,8 +3889,8 @@ <h2>
 
   </script>
 
-  <script src="documentation/vendor/jquery-1.6.4.js"></script>
-  <script src="extras/coffee-script.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
+  <script src="v1/extras/coffee-script.js"></script>
 
 </body>
 </html>
diff --git a/documentation/index.html.js b/documentation/index.html.js
@@ -5,16 +5,16 @@
   <title>CoffeeScript</title>
   <meta name="viewport" content="width=device-width, initial-scale=1" />
   <link rel="canonical" href="http://coffeescript.org" />
-  <link rel="stylesheet" type="text/css" href="documentation/css/docs.css" />
-  <link rel="stylesheet" type="text/css" href="documentation/css/tomorrow.css" />
-  <link rel="shortcut icon" href="documentation/images/favicon.ico" />
+  <link rel="stylesheet" type="text/css" href="v1/css/docs.css" />
+  <link rel="stylesheet" type="text/css" href="v1/css/tomorrow.css" />
+  <link rel="shortcut icon" href="v1/images/favicon.ico" />
 </head>
 <body>
 
   <div id="fadeout"></div>
 
   <div id="flybar">
-    <a id="logo" href="#top"><img src="documentation/images/logo.png" width="225" height="39" alt="CoffeeScript" /></a>
+    <a id="logo" href="#top"><img src="v1/images/logo.png" width="225" height="39" alt="CoffeeScript" /></a>
     <div class="navigation toc">
       <div class="button">
         Table of Contents
@@ -2373,7 +2373,7 @@ six = -&gt;
   </script>
 
   <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
-  <script src="extras/coffee-script.js"></script>
+  <script src="v1/extras/coffee-script.js"></script>
 
 </body>
 </html>