brianjking

GitHub Project Documentation Methods

Just a quick guide on methods I've seen to document GitHub projects. This is not a complete list by any means, just things I've ran across and bookmarked.

More Common

• GitHub Wiki's
• GitHub Sites
• A directory of markdown or AsciiDoc files
• Sphinx generated documentation

brianjking

#Fazal's list of dev tools

##JavaScript ###Node frameworks

• Assemble
• DocPad
• Harp
• Hoodie
• SuperAgent

brianjking

<?php
ob_start();
phpinfo();
$info = ob_get_contents();
ob_end_clean();

$fp = fopen("phpinfo.html", "w+");
fwrite($fp, $info);
fclose($fp);
?>

brianjking

<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta http-equiv="cleartype" content="on">

brianjking

<?php
//* Do NOT include the opening php tag shown above. Copy the code shown below.

//* Customize the credits
add_filter( 'genesis_footer_creds_text', 'sp_footer_creds_text' );
function sp_footer_creds_text() {
	echo '<div class="creds"><p>';
	echo 'Copyright &copy; ';
	echo date('Y');
	echo ' &middot; <a href="http://mydomain.com">My Custom Link</a> &middot; Built on the <a href="http://www.studiopress.com/themes/genesis" title="Genesis Framework">Genesis Framework</a>';

brianjking

# useful nginx configuration for reverse proxy with Apache
# edit lines 8, 11, and 30
# taken from: http://syslog.tv/2010/01/11/debian-apache-2-nginx-wordpress-mu/
# edits by jakebellacera (http://github.com/jakebellacera && http://jakebellacera.com)

server {

	listen 80;

	server_name domain.com *.domain.com; # edit this to your domain

brianjking

# This is a template .gitignore file for git-managed WordPress projects.
#
# Fact: you don't want WordPress core files, or your server-specific
# configuration files etc., in your project's repository. You just don't.
#
# Solution: stick this file up your repository root (which it assumes is
# also the WordPress root directory) and add exceptions for any plugins,
# themes, and other directories that should be under version control.
#
# See the comments below for more info on how to add exceptions for your

brianjking

<?php

/**
* Define type of server
*
* Depending on the type other stuff can be configured
* Note: Define them all, don't skip one if other is already defined
*/

define( 'DB_CREDENTIALS_PATH', dirname( ABSPATH ) ); // cache it for multiple use

brianjking

#!/bin/sh

# Just an abbreviation for creating filenames
SHORT_NAME=je
# hostname as configred in ~/.ssh/config
SERVER_NAME=je
# Database name in production
DB_NAME=XXXX
# Database user in production
DB_USER=XXXX

brianjking

<?php

// Debug Settings
define( 'WP_DEBUG', true );
if ( WP_DEBUG ) {
  define( 'WP_DEBUG_LOG', true );
  define( 'WP_DEBUG_DISPLAY', false );
  define( 'SAVEQUERIES', true );
  define( 'SCRIPT_DEBUG', true );
  @ini_set( 'display_errors',0 );