Skip to content

Latest commit

 

History

History
113 lines (80 loc) · 4.38 KB

README.md

File metadata and controls

113 lines (80 loc) · 4.38 KB
Raw

jQuery.com web-base-template

This is a set of plugins, themes, and configuration files for jQuery's website infrastructure, which is powered by WordPress. It is designed as a custom content directory. So think of web-base-template as your wp-content directory.

Prerequisites

This install guide assumes you already have certain prerequisites already configured within your environment.

  • Apache
  • Mysql
  • PHP

Installation

  1. Configure your local webserver with a virtual host that covers the relevant jQuery domains, such as *.jquery.com and *.jqueryui.com, all pointing to the same root. For example, in Apache:

    <VirtualHost *:80>
ServerName dev.jquery.com
ServerAlias *.jquery.com *.jqueryui.com *.jquery.org *.qunitjs.com *.sizzlejs.com *.jquerymobile.com
DocumentRoot "/srv/www/jquery"
    <Directory /srv/www/jquery>
       Options All
       AllowOverride All
       Order allow,deny
       Allow from all
    </Directory>
</VirtualHost>

  2. Configure your /etc/hosts file to point dev.jquery.com, dev.jqueryui.com, etc. to your local machine. For example:

    127.0.0.1 dev.jquery.com dev.api.jquery.com dev.plugins.jquery.com dev.blog.jquery.com dev.learn.jquery.com
127.0.0.1 dev.jqueryui.com dev.blog.jqueryui.com dev.api.jqueryui.com
127.0.0.1 dev.jquery.org dev.qunitjs.com dev.api.qunitjs.com dev.sizzlejs.com dev.jquerymobile.com dev.api.jquerymobile.com

    Be sure to flush your DNS when you are done. On a Mac, that would be dscacheutil -flushcache.

  3. Place the WordPress core files in the document root you chose. (Don't install it.) You can do this any number of ways:

  4. Clone web-base-template into place, so you have a file tree that looks like this:

    web-base-template/
wp-admin/
wp-content/
wp-includes/
index.php
...

  5. Copy web-base-template/wp-config-sample.php and move it up one directory, to wp-config.php. Fill in your database credentials.

  6. Create an .htaccess file with the following content into that same document root:

    RewriteEngine On
RewriteBase /
RewriteRule ^index\.php$ - [L]

RewriteRule ^resources/?$ index.php [L]
RewriteRule ^resources/(.+) gw-resources/%{HTTP_HOST}/$1 [L]

# Add a trailing slash to the wp-admin of a subsite.
RewriteRule ^([_0-9a-zA-Z\.-]+/)?wp-admin$ $1wp-admin/ [R=301,L]

RewriteCond %{REQUEST_FILENAME} -f [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^ - [L]

# Handle wp-admin, wp-includes, and root PHP files for subsites.
RewriteRule  ^[_0-9a-zA-Z\.-]+/((wp-admin|wp-includes).*) $1 [L]
RewriteRule  ^[_0-9a-zA-Z\.-]+/(.*\.php)$ $1 [L]

RewriteRule . index.php [L]

  7. Go to http://dev.jquery.com and walk through the standard WordPress installation. web-base-template includes a special install script that will initialize the entire network.

Auto-Updates

Changes pushed to master will be pulled onto the stage domain.

Copyright

Copyright 2012 jQuery Foundation and other contributors. All rights reserved.

The web-base-template repository contains themes for rendering all jQuery Foundation web sites.

What is licensed

The contents of these web sites are all available under terms of the MIT license ( http://jquery.org/license ).

Special exception: Code samples are given away for you to freely use, for any purpose. For code samples in API sites and Learn articles (unlike the source code of jQuery projects) you don't even have to say where you got the code from. Just use it.

The PHP files in the web-base-template repository are a derivative work of WordPress, and available under the terms of the GPL license ( http://codex.wordpress.org/License )

What is not licensed

The theme, design, layout, look-and-feel of the web-base-template repository, including all html, css, images, and icons, is not licensed for use. Not by the MIT license or any other license. It is copyrighted. You don't have permission to use it in any way for any purpose, commercial or otherwise. If you have questions about this, please ask a member of the jQuery Content Team.