Permalink
Browse files

Added README and LICENSE

  • Loading branch information...
1 parent 3d83124 commit eb9a1aea6c8933a87b74fefd249dd62862de440f @jsliang committed Feb 11, 2013
Showing with 76 additions and 0 deletions.
  1. +23 −0 LICENSE
  2. +53 −0 README.md
View
@@ -0,0 +1,23 @@
+Copyright (c) 2013, Jui-Shan Liang <jenny@jsliang.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+ list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+ list of conditions and the following disclaimer in the documentation and/or
+ other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
@@ -0,0 +1,53 @@
+# Fresh: a responsive Pelican theme that uses HTML5
+
+Fresh is a [Pelican](http://getpelican.com) theme with clean layout.
+This theme uses HTML5 and its layout is responsive -- thanks to Smashing HTML5 and Twitter Bootstrap.
+
+## Features
+
+* Google Analytics
+* DISQUS comment system
+* Custom link lists
+* Social widgets
+* "Fork me on GitHub" ribbon
+* **Google Custom Search Engine** -- you can use this as your search bar!
+* **Hide categories from menu**
+* Syntax highlighting for code blocks
+
+## Settings
+
+### Built-in Global Variables
+
+The theme supports most Pelican built-in global variables, and some of them are listed below.
+
+* `GOOGLE_ANALYTICS`
+* `DISQUS_SITENAME`
+* `LINKS (('name1', 'url1'), ('name2', 'url2'))`
+* `SOCIAL (('name1', 'url1'), ('name2', 'url2'))`
+* `GITHUB_URL`
+
+Refer to [Pelican's documentation of settings](http://docs.getpelican.com/en/latest/settings.html) for description of these global variables.
+
+### Theme-specific Global Variables
+
+The theme also provides these global variables:
+
+* `GOOGLE_CUSTOM_SEARCH = 'your search engine unique ID'`
+
+ The Fresh theme allows you to use [Google Custom Search Engine](http://www.google.com/cse/) as the search engine for your static website!
+
+ Find the **search engine unique ID** of the search engine you set up in [Google Custom Search Engine's control panel](http://www.google.com/cse/manage/all).
+ Assign this ID to the `GOOGLE_CUSTOM_SEARCH` variable, and a Google custom search bar will appear in the navigation bar.
+
+* `HIDE_CATEGORIES_FROM_MENU = True`
+
+ If you want to hide categories from menu, you can do that by setting `HIDE_CATEGORIES_FROM_MENU` to `True`.
+
+
+## License
+
+Copyright (c) 2013, Jui-Shan Liang &lt;jenny@jsliang.com&gt;
+
+All rights reserved.
+
+Licensed under GPL v2.

0 comments on commit eb9a1ae

Please sign in to comment.