README.html 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. <h1 id='html5_boilerplate'><a href='http://html5boilerplate.com'>HTML5 Boilerplate</a></h1>
  2. <p>HTML5 Boilerplate is a professional front-end template for building fast, robust, and adaptable web apps or sites.</p>
  3. <p>This project is the product of many years of iterative development and combined community knowledge. It does not impose a specific development philosophy or framework, so you&#8217;re free to architect your code in the way that you want.</p>
  4. <ul>
  5. <li>Source: <a href='https://github.com/h5bp/html5-boilerplate'>https://github.com/h5bp/html5-boilerplate</a></li>
  6. <li>Homepage: <a href='http://html5boilerplate.com'>http://html5boilerplate.com</a></li>
  7. <li>Twitter: <a href='http://twitter.com/h5bp'>@h5bp</a></li>
  8. </ul>
  9. <h2 id='quick_start'>Quick start</h2>
  10. <p>Choose one of the following options:</p>
  11. <ol>
  12. <li>Download the latest stable release from <a href='http://html5boilerplate.com/'>html5boilerplate.com</a> or a custom build from <a href='http://www.initializr.com'>Initializr</a>.</li>
  13. <li>Clone the git repo — <code>git clone
  14. https://github.com/h5bp/html5-boilerplate.git</code> - and checkout the tagged release you&#8217;d like to use.</li>
  15. </ol>
  16. <h2 id='features'>Features</h2>
  17. <ul>
  18. <li>HTML5 ready. Use the new elements with confidence.</li>
  19. <li>Cross-browser compatible (Chrome, Opera, Safari, Firefox 3.6+, IE6+).</li>
  20. <li>Designed with progressive enhancement in mind.</li>
  21. <li>Includes <a href='http://necolas.github.com/normalize.css/'>Normalize.css</a> for CSS normalizations and common bug fixes.</li>
  22. <li>The latest <a href='http://jquery.com/'>jQuery</a> via CDN, with a local fallback.</li>
  23. <li>The latest <a href='http://modernizr.com/'>Modernizr</a> build for feature detection.</li>
  24. <li>IE-specific classes for easier cross-browser control.</li>
  25. <li>Placeholder CSS Media Queries.</li>
  26. <li>Useful CSS helpers.</li>
  27. <li>Default print CSS, performance optimized.</li>
  28. <li>Protection against any stray <code>console.log</code> causing JavaScript errors in IE6/7.</li>
  29. <li>An optimized Google Analytics snippet.</li>
  30. <li>Apache server caching, compression, and other configuration defaults for Grade-A performance.</li>
  31. <li>Cross-domain Ajax and Flash.</li>
  32. <li>&#8220;Delete-key friendly.&#8221; Easy to strip out parts you don&#8217;t need.</li>
  33. <li>Extensive inline and accompanying documentation.</li>
  34. </ul>
  35. <h2 id='documentation'>Documentation</h2>
  36. <p>Take a look at the <a href='/h5bp/html5-boilerplate/blob/master/doc/README.md'>documentation table of contents</a>. This documentation is bundled with the project, which makes it readily available for offline reading and provides a useful starting point for any documentation you want to write about your project.</p>
  37. <h2 id='contributing'>Contributing</h2>
  38. <p>Anyone and everyone is welcome to <a href='/h5bp/html5-boilerplate/blob/master/doc/contribute.md'>contribute</a>. Hundreds of developers have helped make the HTML5 Boilerplate what it is today.</p>