Skip to content

Commit c4dd1dc

Browse files
author
Tom Clark
committed
Added more info
1 parent 1ebf07a commit c4dd1dc

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

_layouts/default.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ <h1><a href="http://tutorials.github.com">tutorials.github.com</a></h1>
5454
</div>
5555
<!--[if !IE]><script>fixScale(document);</script><!--<![endif]-->
5656
<script id="sidebar_template" type="text/x-underscore" charset="utf-8">
57+
<em>(Click on us!)</em>
5758
<% _(visible).each(function(values, name) { %>
5859
<h3><%= name %> (<%= visible_counts[name] %>)</h3>
5960
<ul>

index.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,23 @@ README
88

99
tutorials.github.com is a simple hack that uses GitHub Pages to fulfill a need of mine: easily collecting and forking programming tutorials and offering polyglot versions.
1010

11+
Amazon has proven (citation needed) that faceted navigation is superior to search, so let's use that idea for education!
12+
13+
For now, each topic is its own page, and you use the sidebar navigation to drill down into a variant that's most useful to you. It might not look like it, but __the navigation is clickable!__ Try clicking on a language in the [Hello, World!](/pages/hello-world.html) example to get a feel for the navigation.
14+
15+
I _really_ like the idea of customized documentation. If you're looking for documentation, you no longer have to parse a generic tutorial for what's relavent to you and your setup. And if you're an author, you no longer need to inline special directions if someone's on xyz architecture. Just fork the repo, copy an existing tutorial, update the tags, and send a pull request!
16+
17+
In the future, I'll add cookies so the site will apply filters for you and a central collection of tags/values so we have some consistency across various tutorials.
18+
19+
This project originated as a full-blown rails app backed by a database, and I reached a point where I needed user accounts and git repos. Dreading that, I threw it all away for a simpler, git-based workflow to upload data. I sincerely hope you enjoy it and find it useful.
20+
21+
1122
Examples
1223
--------
1324

14-
* [Installing MySQL](pages/installing-mysql.html)
15-
* [Hello, World!](pages/hello-world.html "Hello, World!")
16-
* [Explanation of how it works](pages/test.html)
25+
* [Installing MySQL](/pages/installing-mysql.html)
26+
* [Hello, World!](/pages/hello-world.html "Hello, World!")
27+
* [Explanation of how it works](/pages/test.html)
1728

1829
Contributing
1930
------------

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy