Переглянути джерело
Update README and LICENSE files to reflect additions
Update LICENSE file to include licences for Open Sans and Source Code Pro. Update README to include additional settings options.master
2 змінених файлів з 163 додано та 13 видалено
Розділений перегляд
Параметри порівняння
-
+121 -2LICENSE.md
-
+42 -11README.md
+ 121
- 2
LICENSE.md
Переглянути файл
| @@ -34,7 +34,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |||
| Component Licenses | |||
| ------------------- | |||
| ### Foundation 4 | |||
| ### [Foundation 4]( http://foundation.zurb.com ) | |||
| ~~~ | |||
| Copyright (c) 2011 ZURB, http://www.zurb.com/ | |||
| @@ -59,7 +59,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |||
| ~~~ | |||
| ### Zeptos.js | |||
| ### [Zeptos.js]( http://zeptojs.com/ ) | |||
| ~~~ | |||
| Copyright (c) 2010-2012 Thomas Fuchs | |||
| http://zeptojs.com/ | |||
| @@ -143,3 +143,122 @@ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION | |||
| WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | |||
| ~~~ | |||
| ### [Open Sans]( http://opensans.com/ ) | |||
| ~~~ | |||
| Copyright Steve Matteson | |||
| Licensed under the Apache License, Version 2.0 (the "License"); | |||
| you may not use this file except in compliance with the License. | |||
| You may obtain a copy of the License at | |||
| http://www.apache.org/licenses/LICENSE-2.0 | |||
| Unless required by applicable law or agreed to in writing, software | |||
| distributed under the License is distributed on an "AS IS" BASIS, | |||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |||
| See the License for the specific language governing permissions and | |||
| limitations under the License. | |||
| ~~~ | |||
| ### [Source Code Pro]( https://github.com/adobe/source-code-pro ) | |||
| ~~~ | |||
| Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries. | |||
| This Font Software is licensed under the SIL Open Font License, Version 1.1. | |||
| This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL | |||
| ----------------------------------------------------------- | |||
| SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007 | |||
| ----------------------------------------------------------- | |||
| PREAMBLE | |||
| The goals of the Open Font License (OFL) are to stimulate worldwide | |||
| development of collaborative font projects, to support the font creation | |||
| efforts of academic and linguistic communities, and to provide a free and | |||
| open framework in which fonts may be shared and improved in partnership | |||
| with others. | |||
| The OFL allows the licensed fonts to be used, studied, modified and | |||
| redistributed freely as long as they are not sold by themselves. The | |||
| fonts, including any derivative works, can be bundled, embedded, | |||
| redistributed and/or sold with any software provided that any reserved | |||
| names are not used by derivative works. The fonts and derivatives, | |||
| however, cannot be released under any other type of license. The | |||
| requirement for fonts to remain under this license does not apply | |||
| to any document created using the fonts or their derivatives. | |||
| DEFINITIONS | |||
| "Font Software" refers to the set of files released by the Copyright | |||
| Holder(s) under this license and clearly marked as such. This may | |||
| include source files, build scripts and documentation. | |||
| "Reserved Font Name" refers to any names specified as such after the | |||
| copyright statement(s). | |||
| "Original Version" refers to the collection of Font Software components as | |||
| distributed by the Copyright Holder(s). | |||
| "Modified Version" refers to any derivative made by adding to, deleting, | |||
| or substituting -- in part or in whole -- any of the components of the | |||
| Original Version, by changing formats or by porting the Font Software to a | |||
| new environment. | |||
| "Author" refers to any designer, engineer, programmer, technical | |||
| writer or other person who contributed to the Font Software. | |||
| PERMISSION & CONDITIONS | |||
| Permission is hereby granted, free of charge, to any person obtaining | |||
| a copy of the Font Software, to use, study, copy, merge, embed, modify, | |||
| redistribute, and sell modified and unmodified copies of the Font | |||
| Software, subject to the following conditions: | |||
| 1) Neither the Font Software nor any of its individual components, | |||
| in Original or Modified Versions, may be sold by itself. | |||
| 2) Original or Modified Versions of the Font Software may be bundled, | |||
| redistributed and/or sold with any software, provided that each copy | |||
| contains the above copyright notice and this license. These can be | |||
| included either as stand-alone text files, human-readable headers or | |||
| in the appropriate machine-readable metadata fields within text or | |||
| binary files as long as those fields can be easily viewed by the user. | |||
| 3) No Modified Version of the Font Software may use the Reserved Font | |||
| Name(s) unless explicit written permission is granted by the corresponding | |||
| Copyright Holder. This restriction only applies to the primary font name as | |||
| presented to the users. | |||
| 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font | |||
| Software shall not be used to promote, endorse or advertise any | |||
| Modified Version, except to acknowledge the contribution(s) of the | |||
| Copyright Holder(s) and the Author(s) or with their explicit written | |||
| permission. | |||
| 5) The Font Software, modified or unmodified, in part or in whole, | |||
| must be distributed entirely under this license, and must not be | |||
| distributed under any other license. The requirement for fonts to | |||
| remain under this license does not apply to any document created | |||
| using the Font Software. | |||
| TERMINATION | |||
| This license becomes null and void if any of the above conditions are | |||
| not met. | |||
| DISCLAIMER | |||
| THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |||
| EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF | |||
| MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT | |||
| OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE | |||
| COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | |||
| INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL | |||
| DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |||
| FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM | |||
| OTHER DEALINGS IN THE FONT SOFTWARE. | |||
| ~~~ | |||
+ 42
- 11
README.md
Переглянути файл
| @@ -1,7 +1,7 @@ | |||
| Pelican-red | |||
| ============ | |||
| **Alpha Quality Pre-v0.1.0** | |||
| **Beta Quality Pre-v0.1.0** | |||
| Pelican-red is a [pelican](http://getpelican.com) theme designed to be readable on every device. It is a responsive layout which utilizes the [Foundation 4](http://foundation.zurb.com/) framework. The theme was originally created for the blog [VoltaicIdeas](http://blog.voltaicideas.net) and has a few additional features in addition to the original design to make it more useful. Pelican-red is Licensed under the MIT-License. | |||
| @@ -9,8 +9,8 @@ Features | |||
| --------- | |||
| The following is a list of features: | |||
| * Responsive design view-able on mobile down to 380px wide **(check)** | |||
| * Fixed top-bar w/drop-down navigation & social links | |||
| * Responsive design view-able on mobile down to about 230px wide | |||
| * Top-bar w/drop-down navigation & social links | |||
| * Social links with Icons from [Entypo](http://www.entypo.com) by Daniel Bruce or [Zocial](http://zocial.smcllns.com/) by Sam Collins; currently supported ( icon font pack in parenthesis ): | |||
| * Blogger ( Zocial ) | |||
| * Dribbble ( Entypo ) | |||
| @@ -40,10 +40,14 @@ The following is a list of features: | |||
| * Analytics via Google Analytics ( new version ) or GoSquared | |||
| * Disqus comments support **(TODO FINISH)** | |||
| * PDF link support | |||
| * pygments code highlighting | |||
| * pygments code highlighting with responsive layout | |||
| * Site Icons for Creative Commons Licenses, VCards, Tags, PDF download, Search, and Translation selection using [Entypo](http://www.entypo.com) by Daniel Bruce | |||
| * Google Custom Search Support | |||
| * more ... | |||
| * Open Sans used for style font | |||
| * Source Code Pro used for code blocks | |||
| * Supports the following pelican-plugins (plus others): | |||
| * multi_part | |||
| * neighbors | |||
| Install | |||
| -------- | |||
| @@ -87,16 +91,23 @@ Variables are listed as `variable` : description | |||
| * `SITE_DESCR`: Description of site used for meta if you want | |||
| * `SITE_KEY`: Keywords for meta ex. `"keyword1, keyword2, keyword3"` | |||
| * `FAVICON`: Path to favicon ex. `images/favicon` | |||
| * `COPYRIGHTS`: Copyright dictionary `['Abbriviation': ('name','url')]` | |||
| * `DEFAULT_COPYRIGHT` : Default copyright to use is an abbriviation key from the `COPYRIGHTS` dictionary | |||
| * `COPYRIGHT_ARTICLE` : Show default copyright on articles (overridable with article value) | |||
| * `COPYRIGHT_PAGE` : Show default copyright on pages (overridable with page value) | |||
| * `COPYRIGHTS`: Copyright dictionary `['Abbreviation': ('name','url')]` | |||
| * using `cc`, `cc-nc`, etc will generate iconified copyright links | |||
| * `DEFAULT_COPYRIGHT` : Default copyright to use is an abbreviation key from the `COPYRIGHTS` dictionary | |||
| * `COPYRIGHT_ARTICLE` : Show default copyright on articles (over-ridable with article value) | |||
| * `COPYRIGHT_PAGE` : Show default copyright on pages (over-ridable with page value) | |||
| ### Navigation | |||
| * `MENUITEMS`: Custom Links to place in the menu e. `(('Item', 'Link'))` | |||
| * `DISPLAY_PAGES_ON_MENU`: Show pages on the menu; has three options `False` - do not display, `Compact` - display as dropdown with 'Pages' Heading, and `Expanded` - display each as a seperate top level item. | |||
| * `DISPLAY_CATEGORIES_ON_MENU` : Show the categories on the menu; has same options `False` - do not display, `Compact` - display as dropdown with 'Categories' Heading, and `Expanded` - display each as a seperate top level item. | |||
| ### Sidebar | |||
| * `INCLUDE_TAGS_LINK` : True / False Include link to tags page on sidebar. | |||
| * `INCLUDE_CATS_LINK` : True / False Include link to categories page on sidebar. | |||
| * `INCLUDE_ARCH_LINK` : True / False Include link to archives page on sidebar. | |||
| * `INCLUDE_AUTH_LINK` : True / False Include link to authors page on sidebar. | |||
| ### Social | |||
| * `SOCIAL`: List of the social links and urls ex. `(('Network','url'),)`, supported w/icon listed below: | |||
| * Blogger : `('blogger','http://myblog.blogspot.com')` | |||
| @@ -122,21 +133,41 @@ Variables are listed as `variable` : description | |||
| * Vimeo : `('vimeo','http://vimeo.com/channels/channelID')` | |||
| * YouTube : `('youtube','http://www.youtube.com/channel/channelID')` | |||
| ### Index Page | |||
| * `ARTICLES_ON_INDEX` : number of recent articles to show | |||
| * `PAGES_ON_INDEX` : True / False | |||
| ### Comments ( Disqus ) | |||
| * `DISQUS_SN`: Disqus Shortname of site ( VoltaicIdeas ) | |||
| * `COMMENTS_PAGE`: Include Comments on pages set True/False | |||
| * `COMMENTS_ARTICLE`: Include Comments on articles set True/False | |||
| ### Authors ( vcards ) | |||
| * `AUTHORS` : a dictionary of authors | |||
| * `vcard` : a tuple of tuples of author vcard values support includes (not limited though ): | |||
| * `fn` : Full Name | |||
| * `email` : [email protected] | |||
| * `photo` : url to an image about 150px | |||
| * `title` : Awesome Person, Blog Writer, etc | |||
| * `org` : some company | |||
| * `notes` : this can be a bio / anything really | |||
| * `social` : (('network','link'),) same as SITE_SOCIAL parameters | |||
| ### Analytics ( Google Analytics and GoSquared ) | |||
| * `GOOGLE_ANALYTICS`: Google Analytics Code and Domain ex. `( UA-xxxxxxxx-x' , 'voltaicideas.net' )` | |||
| * `GO_SQUARED`: GoSquared Code ex. `'GSN-xxxxxx-x'` | |||
| ### Google Custom Search | |||
| * `GOOGLE_SEARCH`: set to the unique search id number "var cx = 'this value' " | |||
| Per Article / Page Variables | |||
| -------------------------- | |||
| In addition to the additional configuration variables the theme supports the following variables in articles / pages. | |||
| * `comments`: show comments True/False | |||
| * `comments`: show comments True/False overrides the site comments setting | |||
| * `copyright`: copyright to display at bottom of page / article overrides the site `DEFAULT_COPYRIGHT` value | |||
| * `modified` : a modified time | |||
| * `image` : a cover image for the article also used as icon in listings path relative to `static` directory | |||
| Previews | |||
| --------- | |||
| @@ -157,4 +188,4 @@ TODO | |||
| Change-log ( Major Details ) | |||
| ------------------------- | |||
| * `v0.1.0` First Release | |||
| * `v0.1.0` First Release | |||