documetation update

This commit is contained in:
Kenneth Reitz
2010-04-08 13:04:55 -04:00
parent b85a92ba28
commit ac577fe45f
4 changed files with 210 additions and 63 deletions
Vendored
BIN
View File
Binary file not shown.
+102 -63
View File
@@ -1,80 +1,119 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>kennethreitz/wordpress-theme-skeleton @ GitHub</title>
<style type="text/css">
body {
margin-top: 1.0em;
background-color: #ffffff;
font-family: "Helvetica,Arial,FreeSans";
color: #000000;
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.5'>
<title>theme-skeleton(1) -- WordPress: Repeat All</title>
<style type='text/css'>
body {margin:0}
#man, #man code, #man pre, #man tt, #man kbd, #man samp {
font-family:consolas,monospace;
font-size:16px;
line-height:1.3;
color:#343331;
background:#fff; }
#man { max-width:89ex; text-align:justify; margin:0 25px 25px 25px }
#man h1, #man h2, #man h3 { color:#232221;clear:left }
#man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
#man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
#man h3 { font-size:16px; margin:0 0 0 4ex; }
#man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
#man pre {
color:#333231;
background:#edeceb;
padding:5px 7px;
margin:0px 0 20px 0;
border-left:2ex solid #ddd}
#man pre + h2, #man pre + h3 {
margin-top:22px;
}
#container {
margin: 0 auto;
width: 700px;
#man h2 + pre, #man h3 + pre {
margin-top:5px;
}
h1 { font-size: 3.8em; color: #000000; margin-bottom: 3px; }
h1 .small { font-size: 0.4em; }
h1 a { text-decoration: none }
h2 { font-size: 1.5em; color: #000000; }
h3 { text-align: center; color: #000000; }
a { color: #000000; }
.description { font-size: 1.2em; margin-bottom: 30px; margin-top: 30px; font-style: italic;}
.download { float: right; }
pre { background: #000; color: #fff; padding: 15px;}
hr { border: 0; width: 80%; border-bottom: 1px solid #aaa}
.footer { text-align:center; padding-top:30px; font-style: italic; }
</style>
#man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
#man dt { margin:0; clear:left }
#man dt.flush { float:left; width:8ex }
#man dd { margin:0 0 0 9ex }
#man code, #man strong, #man b { font-weight:bold; color:#131211; }
#man pre code { font-weight:normal; color:#232221; background:inherit }
#man em, var, u {
font-style:normal; color:#333231; border-bottom:1px solid #999; }
#man h1.man-title { display:none; }
#man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
float:left; width:33%; list-style-type:none;
text-transform:uppercase; font-size:18px; color:#999;
letter-spacing:1px;}
#man ol.man { width:100%; }
#man ol.man li.tl { text-align:left }
#man ol.man li.tc { text-align:center;letter-spacing:4px }
#man ol.man li.tr { text-align:right }
#man ol.man a { color:#999 }
#man ol.man a:hover { color:#333231 }
</style>
</head>
<body>
<a href="http://github.com/kennethreitz/wordpress-theme-skeleton"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
<div id='man'>
<div id="container">
<h1 class='man-title'>theme-skeleton(1)</h1>
<div class="download">
<a href="http://github.com/kennethreitz/wordpress-theme-skeleton/zipball/master">
<img border="0" width="90" src="http://github.com/images/modules/download/zip.png"></a>
<a href="http://github.com/kennethreitz/wordpress-theme-skeleton/tarball/master">
<img border="0" width="90" src="http://github.com/images/modules/download/tar.png"></a>
</div>
<ol class='head man'>
<li class='tl'>theme-skeleton(1)</li>
<li class='tc'></li>
<li class='tr'>theme-skeleton(1)</li>
</ol>
<h1><a href="http://github.com/kennethreitz/wordpress-theme-skeleton">wordpress-theme-skeleton</a>
<span class="small">by <a href="http://github.com/kennethreitz">kennethreitz</a></span></h1>
<h2 id='NAME'>NAME</h2>
<p><code>theme-skeleton</code> -- WordPress: Repeat All</p>
<div class="description">
The starting place for every top-knotch WordPress theme.
</div>
<h2>DESCRIPTION</h2>
<h2>Authors</h2>
<p>Kenneth Reitz (me@kennethreitz.com)
<br/>
<br/> </p>
<p>I don't like repeating myself.</p>
<p>To make a long story short, I hate repeating myself. A lot. Every time I sit down to build a WordPress theme for a client, I end out starting the exact same way. So I decided to make a WordPress Theme skeleton. Not only does this saves me hours of time, but after months of refinement, this skeleton has brought my client themes to a whole new level.</p>
<h2>FEATURES</h2>
<ul>
<li>Pre-built <code>functions.php</code>, <code>header.php</code>, <code>footer.php</code>, <code>page.php</code>, <code>single.php</code>, <code>index.php</code>, <code>404.php</code></li>
<li>Out of the box iPhone / iPad CSS support (portrait and landscape). Just edit <a href="http://github.com/kennethreitz/wordpress-theme-skeleton/blob/master/css/iphone.css"><code>iPhone.css</code></a> and <a href="http://github.com/kennethreitz/wordpress-theme-skeleton/blob/master/css/ipad.css"><code>iPad.css</code></a></li>
<li>Additional meta-tags for Mobile Safari</li>
<li>Included Apple Touch Icon (46x46)</li>
<li>Included custom icon for site login screen</li>
<li>jQuery plugin which adds OS, Browser name, and Version to body tag.</li>
<li>jQuery plugin for marking current URL in links</li>
<li>CSS Reset and Standard Attributes included</li>
<li>All page types are available as Page / Post Templates.</li>
<li>Additional body classes added to detect current browser</li>
<li>Official support for <a href="http://omninoggin.com/wordpress-plugins/wp-minify-wordpress-plugin/"><code>wp-minify</code></a></li>
</ul>
<br/> </p>
<h2>Download</h2>
<p>
You can download this project in either
<a href="http://github.com/kennethreitz/wordpress-theme-skeleton/zipball/master">zip</a> or
<a href="http://github.com/kennethreitz/wordpress-theme-skeleton/tarball/master">tar</a> formats.
</p>
<p>You can also clone the project with <a href="http://git-scm.com">Git</a>
<h2>STILL IN THE WORKS...</h2>
<pre>$ git clone git://github.com/kennethreitz/wordpress-theme-skeleton</pre>
</p>
<p>These features will be available soon. If you'd like them sooner, feel free to contribute.</p>
get the source code on GitHub : <a href="http://github.com/kennethreitz/wordpress-theme-skeleton">kennethreitz/wordpress-theme-skeleton</a>
<ul>
<li>Integrated admin'd theme settings</li>
<li>Settings for adding Prototype, MooTools, and ExtCore (defaulting to jQuery of course)</li>
</ul>
<h2>COPYRIGHT</h2>
<p>theme-skeleton is Copyright (C) 2010 Kenneth Reitz</p>
<h2>SEE ALSO</h2>
<p><a href="http://code.kennethreitz.com/wordpress-skeleton/"><code>wp-skeleton(1)</code></a>, <a href="http://github.com/kennethreitz/wp-coreylib"><code>wp-coreylib(7)</code></a>,
<a href="http://code,kennethreitz.com/"><code>http://kennethreitz.github.com</code></a></p>
<ol class='foot man'>
<li class='tl'></li>
<li class='tc'>April 2010</li>
<li class='tr'>theme-skeleton(1)</li>
</ol>
</div>
</body>
</html>
+44
View File
@@ -0,0 +1,44 @@
theme-skeleton(1) -- WordPress: Repeat All
=================================
## DESCRIPTION
I don't like repeating myself.
To make a long story short, I hate repeating myself. A lot. Every time I sit down to build a WordPress theme for a client, I end out starting the exact same way. So I decided to make a WordPress Theme skeleton. Not only does this saves me hours of time, but after months of refinement, this skeleton has brought my client themes to a whole new level.
## FEATURES
* Pre-built `functions.php`, `header.php`, `footer.php`, `page.php`, `single.php`, `index.php`, `404.php`
* Out of the box iPhone / iPad CSS support (portrait and landscape). Just edit [`iPhone.css`](http://github.com/kennethreitz/wordpress-theme-skeleton/blob/master/css/iphone.css) and [`iPad.css`](http://github.com/kennethreitz/wordpress-theme-skeleton/blob/master/css/ipad.css)
* Additional meta-tags for Mobile Safari
* Included Apple Touch Icon (46x46)
* Included custom icon for site login screen
* jQuery plugin which adds OS, Browser name, and Version to body tag.
* jQuery plugin for marking current URL in links
* CSS Reset and Standard Attributes included
* All page types are available as Page / Post Templates.
* Additional body classes added to detect current browser
* Official support for [`wp-minify`](http://omninoggin.com/wordpress-plugins/wp-minify-wordpress-plugin/)
## STILL IN THE WORKS...
These features will be available soon. If you'd like them sooner, feel free to contribute.
* Integrated admin'd theme settings
* Settings for adding Prototype, MooTools, and ExtCore (defaulting to jQuery of course)
## COPYRIGHT
theme-skeleton is Copyright (C) 2010 Kenneth Reitz
## SEE ALSO
[`wp-skeleton(1)`](http://code.kennethreitz.com/wordpress-skeleton/), [`wp-coreylib(7)`](http://github.com/kennethreitz/wp-coreylib),
[`http://kennethreitz.github.com`](http://code,kennethreitz.com/)
+64
View File
@@ -0,0 +1,64 @@
# WordPress 2.9.2 Skeleton - I don't like repeating myself.
# Installation
> cd httpdocs
> git clone git://github.com/kennethreitz/wordpress-skeleton.git .
> git submodule init
> git submodule update
## Enhanced Configurations
* WordPress installed in `/blog/`, but will serve site from `/`
* Robust [`wp-config.php`](http://github.com/kennethreitz/wordpress-skeleton/blob/master/blog/wp-config.php)
- Built to support dev+ops environments w/ debugging
- Default FTP connection info for installing/updating/deleting components
* Ready to go [`.htaccess`](http://github.com/kennethreitz/wordpress-skeleton/blob/master/.htaccess)
- Enables `mod_rewrite` for pretty urls
- Gzip compression for most requests
- Adds reasonable upload file-sizes
* Ready to go [`robots.txt`](http://github.com/kennethreitz/wordpress-skeleton/blob/master/robots.txt)
- No robots on `/archive/` pages
- No robots on `/category/` pages
- No robots on `/tag/` pages
* Example [`/external.php`](http://github.com/kennethreitz/wordpress-skeleton/blob/master/external.php) for dipping into WordPress API from external PHP
## Available [Themes](http://github.com/kennethreitz/wordpress-skeleton/tree/master/blog/wp-content/themes/)
* [KennethReitz's Wordpress Theme Skeleton](http://github.com/kennethreitz/wordpress-theme-skeleton)
* [Jumpchart's Content Wireframing Theme](http://www.jumpchart.com/tour/wordpress/)
## Available [Plugins](http://github.com/kennethreitz/wordpress-skeleton/tree/master/blog/wp-content/plugins/)
* [After the Deadline](http://www.afterthedeadline.com/) (Spelling and grammar checking)
* [Akismet](http://akismet.com/) (Comment spam destroyer)
* [Collabpress](http://wordpress.org/extend/plugins/collabpress/) (Project tracking + task management within backend)
* [CoreyLib](http://github.com/kennethreitz/wp-coreylib) (Universal API parser + cache)
* [Disable Updates](http://github.com/kennethreitz/wp-disable-updates) (I got sick of client sites breaking on updates)
* [Disqus Commenting System](http://wordpress.org/extend/plugins/disqus-comment-system/) (Socialize your site)
* [Extra Feed Links](http://scribu.net/wordpress/extra-feed-links) (Semantics are everything)
* [Front End Editor](http://scribu.net/wordpress/front-end-editor) (Beautiful plugin for editing a page/post's content on the spot)
* [Google Sitemap Generator](http://www.arnebrachhold.de/projects/wordpress-plugins/google-xml-sitemaps-generator/) (Google wants the latest)
* [Markdown Extra 1.2.4](http://michelf.com/projects/php-markdown/) (I don't like typing HTML all the time)
* [More Fields](http://labs.dagensskiva.com/plugins/more-fields/) (No more ugly custom fields + custom post/page types)
* [PageMash](http://wordpress.org/extend/plugins/pagemash/) (Content-heavy sites can be cumbersome)
* [PushPress](http://wordpress.org/extend/plugins/pushpress/) (Support for PubSubHubbub)
* [Redirection](http://urbangiraffe.com/plugins/redirection/) (They are called permalinks for a reason)
* [Role Manager](http://sourceforge.net/projects/role-manager/) (Turns WordPress into a real CMS)
* [Shopp](http://shopplugin.net/) (The total ecommerce package)
* [Tantan S3](http://tantannoodles.com/toolkit/wordpress-s3/) (Amazon S3 for WordPress uploads)
* [Twitter Tools](http://wordpress.org/extend/plugins/twitter-tools/) (AutoPost to Twitter when a post goes live. Soon to be replaced with Salsa )
* [Clippy Syntax Highlighter](http://github.com/kennethreitz/wp-clippy-syntax-plugin) (GeSHi + Clippy from GitHub for one-click copying of code)
* [WP-Dummy Content](http://wordpress.org/extend/plugins/wp-dummy-content/) (Fills your WordPress installation w/ dummy content)
* [WP-Minify](http://omninoggin.com/wordpress-plugins/wp-minify-wordpress-plugin/) (Fantastic Auto minification plugin w/ cacheing)
* [WP-Super Cache](http://wordpress.org/extend/plugins/wp-super-cache/) (Very robust plugin for cacheing Posts and/or Pages)
* [WP-Touch](http://www.bravenewcode.com/products/wptouch/) (One click lazy man's iPhone support)
## In the Works
* Salsa: Facebook and Twitter updates for WordPress
**Enjoy :)**