doc: add start of website

rubyworks · May 15, 2011 · 5a6c840 · 5a6c840
1 parent 724532d
commit 5a6c840
Show file tree

Hide file tree

Showing 7 changed files with 244 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,32 +1,28 @@
-yard-tomdoc
-===========
+# yard-tomdoc
 
-Description
------------
+
+## Description
 
 Implements [TomDoc](http://tomdoc.org) syntax for YARD. 'Nuff said.
 
 
-Usage
------
+## Usage
 
 Since `yard-tomdoc` is a standard YARD plugin, utilize it with yard's
 `--plugin` option.
 
     $ yard --plugin yard-tomdoc [...]
 
 
-Limitations
------------
+## Limitations
 
 Before you use yard-tomdoc you should read about the differences between YARD
 and TomDoc syntax [here](http://gnuu.org/2010/05/12/whats-missing-from-tomdoc/).
 
 
-Licensing
----------
+## Licensing
 
-Copyright (c) 2010 Loren Segal
+Copyright (c) 2010 Loren Segal, Thomas Sawyer
 
 See the `NOTICE` file for license information on TomDoc.
 
diff --git a/site/assets/fork-me.png b/site/assets/fork-me.png
diff --git a/site/assets/highlight.css b/site/assets/highlight.css
@@ -0,0 +1,96 @@
+/* github.com style (c) Vasily Polovnyov <vast@whiteants.net> */
+
+/* NOTE: This has been included in the rdoc.css stylesheet
+   rather then have it's own file simply b/c I have not 
+   figured out how to utilize my own generator to be able
+   to copy additional files.
+ */
+
+pre code {
+    display: block;
+    color: #000;
+    background: #f8f8ff;
+    background: #eee;
+    -moz-border-radius: 10px;
+    border-radius: 10px;
+}
+
+code .comment, .template_comment, .diff .header, .javadoc {
+    color: #998;
+    font-style: italic
+}
+
+code .keyword, .css .rule .keyword, .winutils, .javascript .title, .lisp .title, .subst {
+    color: #000;
+    font-weight: bold 
+}
+
+code .number, .hexcolor {
+    color: #40a070
+}
+
+code .string, .attribute .value, .phpdoc {
+    color: #d14
+}
+
+code .title, .id {
+    color: #900;
+    font-weight: bold
+}
+
+code .javascript .title, .lisp .title, .subst {
+    font-weight: normal
+}
+
+code .class .title {
+    color: #458;
+    font-weight: bold
+}
+
+code .tag, .css .keyword, .html .keyword, .tag .title, .django .tag .keyword {
+    color: #000080;
+    font-weight: normal
+}
+
+code .attribute, .variable, .instancevar, .lisp .body {
+    color: #008080
+}
+
+code .regexp {
+    color: #009926
+}
+
+code .class {
+    color: #458;
+    font-weight: bold
+}
+
+code .symbol, .lisp .keyword {
+    color: #990073
+}
+
+code .builtin, .built_in, .lisp .title {
+    color: #0086b3
+}
+
+code .preprocessor, .pi, .doctype, .shebang, .cdata {
+    color: #999;
+    font-weight: bold
+}
+
+code .deletion {
+    background: #fdd
+}
+
+code .addition {
+    background: #dfd
+}
+
+code .diff .change {
+    background: #0086b3
+}
+
+code .chunk {
+    color: #aaa
+}
+
diff --git a/site/assets/highlight.js b/site/assets/highlight.js
diff --git a/site/assets/jquery.js b/site/assets/jquery.js
diff --git a/site/assets/ss8.png b/site/assets/ss8.png
diff --git a/site/index.html b/site/index.html
@@ -0,0 +1,121 @@
+<html>
+<head>
+  <title>Yard TomDoc</title>
+  <link rel="icon" type="image/gif" href="assets/cardinal.gif" />
+  <style>
+    body { margin: 0; padding: 0; font-family: sans-serif; }
+    a { text-decoration: none; font-size: 0.9em; }
+    a:hover { text-decoration: underline; }
+    li p { margin: 0px; padding: 2px; }
+    pre { padding: 10px; }
+    button { border: none; background: transparent; font-size: 1.3em; }
+    button:hover { color: red; }
+
+    .page { margin: 0 auto; width: 960px; }
+
+    #header { padding: 20px 0 50px 0; background-color: #eee; }
+    #header h1 { font-size: 40px; color: #4499FF; font-family: sans-serif; padding: 0; margin: 0; }
+    #header h2 { font-size: 13px; color: #777; font-family: sans-serif; margin: -5px 0 0 0; padding: 0 0 0 5px; font-weight: normal; }
+    #header p { border: 1px solid #333; border-radius: 10px; width: 150px; padding: 20px; margin: 30px 0; }
+
+    #nav a { background-color: yellow; border: 1px solid #ccc; color: #555; padding: 5px 8px; margin: 0 10px 0 0; font-size: 0.8em; }
+
+    .sidenote { float: right; width: 200px; background: #fff; border: 1px solid #ccc; padding: 5px; text-align: center; margin: 10px; }
+
+    #birdframe { background: url(assets/ss8.png) top center no-repeat #e4e4e4; border-top: 1px solid #ccc; border-bottom: 1px solid #ccc; }
+
+    #readme { margin: 60px auto; width: 960px; color: #333; }
+
+    #footer { margin: 30px auto; width: 960px; font-size: 0.8em; color: #777; }
+    #footer .ad { margin: 0 auto; width: 730px; }
+
+    #copyright { margin-top: 20px; text-align: center; padding: 5px; }
+  </style>
+
+  <script language="javascript" type="text/javascript" src="assets/jquery.js"></SCRIPT>
+  <script language="javascript" type="text/javascript" src="assets/highlight.js"></SCRIPT>
+
+  <script type="text/javascript">
+    $(document).ready(function() {
+      $('#readme').load('readme.html', function(){
+        $('pre').wrapInner('<code></code>');
+        hljs.tabReplace = '    ';
+        hljs.initHighlightingOnLoad('ruby');
+      });
+    });
+  </script>
+
+  <link type="text/css" rel="stylesheet" href="assets/highlight.css" />
+</head>
+<body>
+  <div id="header">
+    <div class="page">
+      <div class="sidenote">
+        Latest Release: <b>0.1.1</b><br/>
+
+        <a href="docs/api/README.html">README</a>
+      </div>
+      <h1>YARD TOMDOC</h1>
+      <h2>Write documentation Tom's way!</h2>
+      <br />
+      <div id="nav">
+        <a href="docs/api">API</a>
+        <a href="http://github.com/rubyworks/yard-tomdoc">Source</a>
+        <a href="http://rubygems.org/gem/yard-tomdoc">Gem</a>
+        <a href="http://googlegroups.com/group/rubyworks-mailinglist">Mail</a>
+      </div>
+    </div>
+  </div>
+
+  <div id="birdframe" style="height: 300px">
+    <div class="page" style="text-align: center;">
+      <h1>YARD knows TomDoc</h1>
+      <!-- <img src="assets/tom.gif" height="290px" style="margin-left: 500px;" /> -->
+    </div>
+  </div>
+
+  <!--
+  <div class="page" style="padding: 30px 0;">
+    <button onclick="$('#readme').toggle();">Click here to learn more...</button>
+  </div>
+  -->
+
+  <br style="clear: both;" />
+
+  <div id="readme" style="display: none;">
+    Sorry the README document did not load.
+  </div>
+
+  <br style="clear: both;" />
+
+  <div id="footer">
+    <div class="ad">
+      <script type="text/javascript"><!--
+      google_ad_client = "ca-pub-1126154564663472";
+      /* RUBYWORKS 09-10-02 728x90 */
+      google_ad_slot = "0788888658";
+      google_ad_width = 728;
+      google_ad_height = 90;
+      //-->
+      </script>
+      <script type="text/javascript"
+      src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
+      </script>
+    </div>
+  </div>
+
+  <div id="copyright">
+    Copyright (c) 2011 Thomas Sawyer
+  </div>
+
+  <div style="position: absolute; top: 0; right: 0;">
+    <a href="http://github.com/rubyworks/yard-tomdoc"><img src="assets/fork-me.png" /></a>
+  </div>
+
+  <div id="rubyworks" style="position: fixed; bottom: 5px; right: 10px; padding: 0; opacity: 0.3;">
+    <a href="http://rubyworks.github.com">
+      <img src="http://rubyworks.github.com/assets/images/seal.png" height="150px" />
+    </a>
+  </div>
+</body>
+</html>