adds documentation index and link on the main page

acutelanguage · Sep 8, 2011 · ce9f434 · ce9f434
1 parent c0f8b23
commit ce9f434
Show file tree

Hide file tree

Showing 6 changed files with 70 additions and 4 deletions.
diff --git a/css/style.css b/css/style.css
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Acute Programming Language</title>
+    <meta charset='UTF-8' />
+    <meta content='IE=edge,chrome=1' http-equiv='X-UA-Compatible' />
+    <meta content='width=device-width, initial-scale=1.0' name='viewport' />
+    <link href='/css/style.css' rel='stylesheet' />
+  </head>
+  <body>
+    <div id='container'>
+      <div id='header'>
+        <h1>Acute!</h1>
+        <h6>Small, focused documentation</h6>
+      </div>
+      <div id='content'>
+        <h2 id='documentation'>Documentation</h2>
+
+        <p>This list of documentation is by no means complete, and will be expanded on as appropriate. Feel free to <a href='https://github.com/acutelanguage/acutelanguage.github.com'>clone this repository</a>, add to the documentation and send a pull request.</p>
+
+        <h3 id='syntax'><a href='/docs/syntax.html'>Syntax</a></h3>
+
+        <p>This document describes the syntax of Acute, including some code examples.</p>
+
+        <h3 id='object_model'>Object Model</h3>
+
+        <p>Here we discuss the object model in detail, including all hooks you have access to, why we do things this way, and why we believe our model to be awesome.</p>
+
+        <h3 id='methods'>Methods</h3>
+
+        <p>In this section, you&#8217;ll learn how methods are implemented, how to use them, and why they&#8217;re so powerful.</p>
+      </div>
+      <div id='footer'>
+        <p>
+          Generated by
+          <a href='http://sinefunc.com/proton/'>Proton</a>
+          and hosted on
+          <a class='period' href='https://github.com/'>GitHub</a>
+        </p>
+      </div>
+    </div>
+  </body>
+</html>
diff --git a/index.html b/index.html
@@ -21,7 +21,8 @@ <h6>A small, focused language</h6>
         </p>
         <h3>Feature list, ready for it?</h3>
         <p>
-          Here's a list of the features in Acute, more detail will be covered in the documentation. (Yes, I know there's no link there right now.)
+          Here's a list of the features in Acute, more detail will be covered in the
+          <a href='/docs/index.html'>documentation.</a>
           <ul>
             <li>Lightweight Object-Oriented language</li>
             <li>Bootstrapped in Ruby (later, LLVM IR)</li>

diff --git a/site/css/style.scss b/site/css/style.scss
@@ -6,7 +6,7 @@ $standard-width: 1em;
 $large-width: 4em;
 
 body {
-  margin-left: 10%;
+  margin-left: 20%;
   background-color: $background;
 }
 

diff --git a/site/docs/index.md b/site/docs/index.md
@@ -0,0 +1,21 @@
+layout: default
+title: Acute Programming Language
+subtitle: Small, focused documentation
+---
+## Documentation
+
+This list of documentation is by no means complete, and will be expanded on as appropriate. Feel free to [clone this repository](https://github.com/acutelanguage/acutelanguage.github.com),
+add to the documentation and send a pull request.
+
+### [Syntax](/docs/syntax.html)
+
+This document describes the syntax of Acute, including some code examples.
+
+### Object Model
+
+Here we discuss the object model in detail, including all hooks you have access to, why we do things this way, and why we believe our model to be awesome.
+
+### Methods
+
+In this section, you'll learn how methods are implemented, how to use them, and why they're so powerful.
+
diff --git a/site/index.haml b/site/index.haml
@@ -8,7 +8,8 @@ subtitle: A small, focused language
   and aims to be entirely self-hosting. After all, any language worth its weight in NAND flash is self-hosting, isn't it?
 %h3 Feature list, ready for it?
 %p
-  Here's a list of the features in Acute, more detail will be covered in the documentation. (Yes, I know there's no link there right now.)
+  Here's a list of the features in Acute, more detail will be covered in the
+  %a{:href => "/docs/index.html"} documentation.
   %ul
     %li Lightweight Object-Oriented language
     %li Bootstrapped in Ruby (later, LLVM IR)