Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 60 lines (39 sloc) 4.812 kb
0cf1e973 » Matthias Mees
2011-09-06 Rudimentary README. Basically a »use at your own risk« warning.
1 # 2k11 – A new default theme for Serendipity
2
8446c488 » Matthias Mees
2011-09-13 Updated documentation.
3 2k11 is supposed to become the new default theme for the [Serendipity (s9y) blog engine](http://s9y.org).
0cf1e973 » Matthias Mees
2011-09-06 Rudimentary README. Basically a »use at your own risk« warning.
4
5 ## Disclaimer
6
5fd0970e »
2012-01-29 Documentation cleanup.
7 This is the development branch of 2k11. This is still subject to (sometimes experimental) changes. I do **not** recommend using it in a production environment.
ecf98681 » Matthias Mees
2011-09-07 Updated README with notes on theme option.
8
39e1792a » Matthias Mees
2011-09-07 Updated README with testing instructions.
9 ### Testing
10
934661c2 »
2012-01-29 Fixed some typos.
11 If you *do* want to test it, your blog needs to run at least s9y v1.6. Extract the downloaded archive. I recommend downloading a `.zip` or `.tar.gz` file from the [Tags section](https://github.com/yellowled/s9y-2k11/tags) rather than cloning the repo. Keep the folder name if you want to be able to test multiple versions or rename it to `2k11` to have just one version installed. Copy it to `/templates/` and activate it in the s9y backend. (Might need a reload in the frontend.)
39e1792a » Matthias Mees
2011-09-07 Updated README with testing instructions.
12
934661c2 »
2012-01-29 Fixed some typos.
13 **Note:** If you used Bulletproof or a similar template with a customizable navigation, the global navigation in 2k11 **will** overwrite your current navigation. Please write down your navigation's URLs and link texts *before* switching to 2k11.
434066d8 » Matthias Mees
2011-11-18 Updated docs.
14
bb8b1261 »
2012-06-01 Added some notes about reporting bugs.
15 ### Reporting bugs
16
17 Please use the [GitHub issue tracker](https://github.com/yellowled/s9y-2k11/issues) or email to report bugs. Also make sure you include some kind of version number with your bug report -- a [tag](https://github.com/yellowled/s9y-2k11/tags) if you use a tagged version or the [SHA hash](https://github.com/yellowled/s9y-2k11/commits/master) of the commit if you use a forked/cloned GitHub version. Both are also included in the name of the `.zip` or `.tar.gz` files if you're using the GitHub download button to get the latest version.
18
19 If you have a blog running said version, please also state your URL in your bug report.
20
ecf98681 » Matthias Mees
2011-09-07 Updated README with notes on theme option.
21 ## Features
22
1dac1ad4 »
2012-04-08 Edited documentation.
23 2k11 is a responsive HTML5 template. It has a fluid grid layout which adapts to the visitor's screen resolution, even on smaller screens down to smartphones. 2k11 looks plain and simple by design, hoping it will appeal to as many users as possible.
24
25 ### It is built using:
2771d31f » Matthias Mees
2011-09-28 Updated documentation concerning placeholder polyfill.
26
27 * [HTML5 Boilerplate](http://h5bp.com)
28 * [Modernizr](http://www.modernizr.com)
29 * [jQuery](http://jquery.com)
5fd0970e »
2012-01-29 Documentation cleanup.
30 * *Optional:* [Google webfonts](http://www.google.com/webfonts)
2528f932 »
2012-02-05 Updated docs.
31 * [Respond](https://github.com/scottjehl/Respond)
5fd0970e »
2012-01-29 Documentation cleanup.
32 * [iOS Orientationchange Fix](https://github.com/scottjehl/iOS-Orientationchange-Fix)
33 * [FitVids.js](https://github.com/davatron5000/FitVids.js)
ab51786e »
2012-04-07 Updated documentation.
34 * [CSS Tricks small screen navigation](http://css-tricks.com/13303-convert-menu-to-dropdown/)
35 * [jQuery placeholder](https://github.com/mathiasbynens/jquery-placeholder)
13cb3b47 » Matthias Mees
2011-10-02 Updated documentation.
36 * [Details-Polyfill](https://github.com/manuelbieh/Details-Polyfill)
5fd0970e »
2012-01-29 Documentation cleanup.
37 * [AccessifyHTML5](https://github.com/yatil/accessifyhtml5.js)
e6d8284d » Matthias Mees
2011-09-07 Dropped TODO – category nesting should be fixed in the core/plugin.
38
59454bf1 » Matthias Mees
2011-09-07 Updated README with notes on layout options.
39 ### Layout options
40
41 2k11 supports three different layouts, activated by pushing sidebar plugins to the standard left/hidden/right sidebars in plugin management in the backend:
ab51786e »
2012-04-07 Updated documentation.
42
59454bf1 » Matthias Mees
2011-09-07 Updated README with notes on layout options.
43 * 3 columns, left + right sidebars
44 * 2 columns, left sidebar only
45 * 2 columns, right sidebar only
46
5fd0970e »
2012-01-29 Documentation cleanup.
47 If you leave *both* sidebars empty, you'll get a layout which looks like 2 columns, right sidebar only – just without a sidebar. Also, the 3-column layout will display both sidebars on one side in small resolutions, effectively turning it into a 2-column layout in those resolutions.
59454bf1 » Matthias Mees
2011-09-07 Updated README with notes on layout options.
48
ecf98681 » Matthias Mees
2011-09-07 Updated README with notes on theme option.
49 ### Theme options
50
51 * **Date format:** Sets a date format used _globally_ in the theme, i.e. for entries, comments, trackbacks, static pages. Basically for anything controlled by the .tpl files provided by 2k11.
52 * **Header image:** Pick an image from the s9y media database (or leave empty to omit). This will be added as a banner img between header/search and navigation. It's a responsive images only displayed in screen resolutions higher than 600 pixels. Should be 1120 pixels wide to work properly.
53 * **Google webfont:** Pick one of five preselected webfonts or the 'none' option to use Helvetica/Arial. These webfonts are included via the Google webfonts API.
9e2d9288 » Matthias Mees
2011-10-02 Updated documentation.
54 * **User stylesheet:** Includes an additional stylesheet. Note that this **must** be called `user.css` and you have to create it manually in your template directory. Also note that both this and the Google webfont option add an additional HTTP request which might cause slight performance issues.
956c9226 »
2012-10-01 Added new theme option.
55 * **Comment references:** Includes a link to related comment to comments which are replies to another comment, so you can scroll to referenced comment on click.
605aaf95 » Matthias Mees
2011-11-06 Updated to reflect latest nav changes.
56 * **Navigation:** Global navigation provided by s9y core. Switches to an (additionally added using JS) `select` as a pseudo dropdown menu on small screens. Automagically suppresses links if link text *or* URL is empty, also has an option to not emit the nav at all.
d6c23917 » Matthias Mees
2011-11-20 Updated documentation.
57
58 ### user.css Generator
59
1dac1ad4 »
2012-04-08 Edited documentation.
60 Since changing the (desktop) layout isn't *that* easy for CSS novices, I have built a basic generator: [2k11 user.css generator](http://yellowled.github.com).
Something went wrong with that request. Please try again.