Add docs for Gitignore Templates API

pengwynn · pengwynn · commit a6692d4ceabb · 2012-11-29T13:39:14.000-06:00
diff --git a/content/v3/repos/gitignore.md b/content/v3/repos/gitignore.md
@@ -0,0 +1,62 @@
+---
+title: Gitignore templates | GitHub API
+---
+
+# Gitignore Templates API
+
+* TOC
+{:toc}
+
+When you create a new GitHub repository via the API, you can specify a
+[.gitignore template][what-is] to apply to the repository upon creation. The
+.gitignore Templates API lists and fetches templates from the [GitHub .gitignore repository][templates-repo].
+
+## Listing available templates
+
+List all templates available to pass as an option when [creating a repository][create-repo].
+
+    GET /gitignore/templates
+
+### Response
+
+<%= headers 200 %>
+<%= json(:templates)  %>
+
+## Get a single template
+
+The API also allows fetching the source of a single template.
+
+    GET /gitignore/templates/C
+
+### Response
+
+<%= headers 200 %>
+<%= json(:template)  %>
+
+Use the raw [media type][media-type] to get the raw contents.
+
+<%= headers 200 %>
+<pre>
+# Object files
+*.o
+
+# Libraries
+*.lib
+*.a
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+</pre>
+
+[what-is]: https://help.github.com/articles/ignoring-files
+[templates-repo]: https://github.com/github/gitignore
+[create-repo]: /v3/repos/#create
+[media-type]: /v3/media/
diff --git a/layouts/default.html b/layouts/default.html
@@ -107,6 +107,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/repos/">R
               <li><a href="/v3/repos/contents/">Contents</a></li>
               <li><a href="/v3/repos/downloads/">Downloads</a></li>
               <li><a href="/v3/repos/forks/">Forks</a></li>
+              <li><a href="/v3/repos/gitignore/">Gitignore</a></li>
               <li><a href="/v3/repos/keys/">Keys</a></li>
               <li><a href="/v3/repos/hooks/">Hooks</a></li>
               <li><a href="/v3/repos/merging/">Merging</a></li>
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -93,6 +93,7 @@ def text_html(response, status, head = {})
         res = CGI.escapeHTML(response)
         hs + %(<pre class="highlight"><code>) + res + "</code></pre>"
       end
+
     end
 
     USER = {
@@ -997,6 +998,21 @@ def text_html(response, status, head = {})
       :url => "https://api.github.com/repos/octocat/example/subscription",
       :repository_url => "https://api.github.com/repos/octocat/example"
     REPO_SUBSCRIPTION.delete :thread_url
+
+    TEMPLATE = {
+      :name => "C",
+      :source => "# Object files\n*.o\n\n# Libraries\n*.lib\n*.a\n\n# Shared objects (inc. Windows DLLs)\n*.dll\n*.so\n*.so.*\n*.dylib\n\n# Executables\n*.exe\n*.out\n*.app\n"
+    }
+
+    TEMPLATES = [
+      "Actionscript",
+      "Android",
+      "AppceleratorTitanium",
+      "Autotools",
+      "Bancha",
+      "C",
+      "C++"
+    ]
   end
 end
 
