arsenetar/pelican-red
1
0
Fork 0
mirror of https://github.com/arsenetar/pelican-red.git synced 2024-10-29 19:35:57 +00:00
Code Releases Activity
36a9cee676
pelican-red/README.md

204 lines
9.1 KiB
Markdown
Raw Normal View History

Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Pelican-red
============
Update README.md mention prerelease status Updates the Readme to note that the code is not fully completed yet, in addition to a few minor edits.
2013-05-28 02:21:47 +00:00
Update README.md
2013-07-14 00:25:08 +00:00
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.
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Update README.md
2013-07-14 00:25:08 +00:00
Features
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
---------
The following is a list of features:
Update README.md add previews
2013-08-05 17:12:13 +00:00
* Responsive design view-able on mobile down to about 300px wide
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.
2013-07-29 20:05:07 +00:00
* Top-bar w/drop-down navigation & social links
Update README.md to reflect changes in codebase Mainly this changes from the old google analytics variables and switches from using requirejs to yepnopejs.
2013-07-14 05:02:35 +00:00
* 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 ):
Update README.md
2013-07-14 00:25:08 +00:00
* Blogger ( Zocial )
* Dribbble ( Entypo )
* Facebook ( Entypo )
* Flickr ( Entypo )
* Github ( Entypo )
* GrooveShark ( Zocial )
* Google+ ( Entypo )
* Instagram ( Entypo )
* Lastfm ( Entypo )
* LinkedIn ( Entypo )
* Picasa ( Entypo )
* Pinterest ( Entypo )
* Rdio ( Entypo )
* Reddit ( Zocial )
* Skype ( Entypo )
* SoundCloud ( Entypo )
* Steam ( Zocial )
* StumbleUpon ( Entypo )
* Tumblr ( Entypo )
* Twitter ( Entypo )
* Vimeo ( Entypo )
* YouTube ( Zocial )
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
* Style-sheets built using sass & compass
* zeptos.js used instead of jQuery when possible
Update README.md to reflect changes in codebase Mainly this changes from the old google analytics variables and switches from using requirejs to yepnopejs.
2013-07-14 05:02:35 +00:00
* Javascript files loaded via [yepnope.js](http://yepnopejs.com/) (part of modernizr) from CDN [jsDelivr](http://www.jsdelivr.com/) with local fallback
* Analytics via Google Analytics ( new version ) or GoSquared
Update README.md add previews
2013-08-05 17:12:13 +00:00
* Disqus comments support
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.
2013-07-29 20:05:07 +00:00
* pygments code highlighting with responsive layout
Update README.md
2013-07-14 00:25:08 +00:00
* Site Icons for Creative Commons Licenses, VCards, Tags, PDF download, Search, and Translation selection using [Entypo](http://www.entypo.com) by Daniel Bruce
Update README.md add previews
2013-08-05 17:12:13 +00:00
* Google Custom Search Support (works with overlay)
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.
2013-07-29 20:05:07 +00:00
* Open Sans used for style font
* Source Code Pro used for code blocks
Update README.md add previews
2013-08-05 17:12:13 +00:00
* Vcards (hcards) and micro-formatting for articles, pages, and authors
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.
2013-07-29 20:05:07 +00:00
* Supports the following pelican-plugins (plus others):
* multi_part
* neighbors
Update README.md add previews
2013-08-05 17:12:13 +00:00
* related_posts
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Install
--------
Update README.md mention prerelease status Updates the Readme to note that the code is not fully completed yet, in addition to a few minor edits.
2013-05-28 02:21:47 +00:00
To install pelican-red first either clone the repository or download the zip of the current version to a destination of your choice ( `~/pelican-red` used in example ):
Update README.md
2013-07-14 00:25:08 +00:00
~~~Shell
git clone https://github.com/arsenetar/pelican-red.git ~/pelican-red
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
~~~
or
Update README.md
2013-07-14 00:25:08 +00:00
~~~Shell
wget https://github.com/arsenetar/pelican-red/archive/master.zip
unzip master.zip
mv pelican-red-master ~/pelican-red
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
~~~
The theme can then either be used by installing the theme or just by pointing to it.
Update README.md mention prerelease status Updates the Readme to note that the code is not fully completed yet, in addition to a few minor edits.
2013-05-28 02:21:47 +00:00
### Option 1 - Install
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Using pelican-themes (~/pelican-red is path to the theme used in previous example):
Update README.md
2013-07-14 00:25:08 +00:00
~~~Shell
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
pelican-themes --install ~/pelican-red
~~~
Then change the theme in the Pelican settings file for the site you want to use pelican-red:
Update README.md
2013-07-14 00:25:08 +00:00
~~~Python
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
THEME = "pelican-red"
~~~
### Option 2 - Just Point to It
Edit your Pelican settings file for the site you want to use pelican-red (~/pelican-red is path to the theme used in previous example):
Update README.md
2013-07-14 00:25:08 +00:00
~~~Python
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
THEME = "~/pelican-red"
~~~
Configuration
--------------
In addition the to general Pelican configuration variables pelican-red supports a few additional settings. All the variables are set in your Pelican settings file for the site you are using pelican-red with.
Variables are listed as `variable` : description
### General
* `SITE_DESCR`: Description of site used for meta if you want
* `SITE_KEY`: Keywords for meta ex. `"keyword1, keyword2, keyword3"`
Update README.md
2013-07-14 00:25:08 +00:00
* `FAVICON`: Path to favicon ex. `images/favicon`
Update README.md add previews
2013-08-05 17:12:13 +00:00
* `PAGE_DESC` : a dictionary of page descriptions used to generate unique description meta on articles.html, authors.html, index.html, tags.html, and categories.html pages; keyed on lowercase page name.
### Copyright
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.
2013-07-29 20:05:07 +00:00
* `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)
Update README.md add previews
2013-08-05 17:12:13 +00:00
* `COPYRIGHT_HOLDER` : set the holder of the copyright, defaults to `AUTHOR`
* `COPYRIGHT_YEAR` : set the copyright year, no default value
Update README.md
2013-07-14 00:25:08 +00:00
### 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.
Update README.md add previews
2013-08-05 17:12:13 +00:00
* `DISPLAY_ARCHIVE_ON_MENU` : True / False Show a link to the archive on the navigation menu
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
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.
2013-07-29 20:05:07 +00:00
### 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.
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
### Social
Update README.md
2013-07-14 00:25:08 +00:00
* `SOCIAL`: List of the social links and urls ex. `(('Network','url'),)`, supported w/icon listed below:
* Blogger : `('blogger','http://myblog.blogspot.com')`
* Dribbble : `('dribble','http://dribbble.com/username')`
* Facebook : `('facebook','http://www.facebook.com/username')`
* Flickr : `('flickr','http://www.flikr.com/photos/username')`
* Github : `('github','https://github.com/username')`
* GrooveShark : `('grooveshark','http://grooveshark.com/username')`
* Google+ : `('gplus','https://plus.google.com/profileID')`
* Instagram : `('instagram','http://instagram.com/username')`
* Lastfm : `('lasstfm','http://www.last.fm/user/username')`
* LinkedIn : `('linkedin','http://www.linkedin.com/in/username')`
* Picasa : `('picasa','http://')`
* Pinterest : `('pinterest','http://pinterest.com/username')`
* Rdio : `('rdio','http://www.rdio.com/people/username')`
* Reddit : `('reddit','http://www.reddit.com/user/username')`
* Skype : `('skype','skype:username?chat')`
* SoundCloud : `('soudcloud','https://soundcloud.com/profileID')`
* Steam : `('steam','http://steamcommunity.com/profiles/profileID')`
* StumbleUpon : `('stumbleupon','http://www.stumbleupon.com/stumbler/username')`
* Tumblr : `('tumblr','http://myblog.tumblr.com')`
* Twitter : `('twitter','http://twitter.com/username')`
* Vimeo : `('vimeo','http://vimeo.com/channels/channelID')`
* YouTube : `('youtube','http://www.youtube.com/channel/channelID')`
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
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.
2013-07-29 20:05:07 +00:00
### Index Page
* `ARTICLES_ON_INDEX` : number of recent articles to show
* `PAGES_ON_INDEX` : True / False
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
### Comments ( Disqus )
Update README.md
2013-07-14 00:25:08 +00:00
* `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
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Update README.md add previews
2013-08-05 17:12:13 +00:00
### Authors ( vcards / hcards ) w/ microformats
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.
2013-07-29 20:05:07 +00:00
* `AUTHORS` : a dictionary of authors
* `vcard` : a tuple of tuples of author vcard values support includes (not limited though ):
* `fn` : Full Name
* `email` : name@service.com
* `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
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
### Analytics ( Google Analytics and GoSquared )
Update README.md to reflect changes in codebase Mainly this changes from the old google analytics variables and switches from using requirejs to yepnopejs.
2013-07-14 05:02:35 +00:00
* `GOOGLE_ANALYTICS`: Google Analytics Code and Domain ex. `( UA-xxxxxxxx-x' , 'voltaicideas.net' )`
* `GO_SQUARED`: GoSquared Code ex. `'GSN-xxxxxx-x'`
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
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.
2013-07-29 20:05:07 +00:00
### Google Custom Search
* `GOOGLE_SEARCH`: set to the unique search id number "var cx = 'this value' "
Update README.md
2013-07-14 00:25:08 +00:00
Per Article / Page Variables
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
--------------------------
Update README.md
2013-07-14 00:25:08 +00:00
In addition to the additional configuration variables the theme supports the following variables in articles / pages.
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
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.
2013-07-29 20:05:07 +00:00
* `comments`: show comments True/False overrides the site comments setting
Update README.md
2013-07-14 00:25:08 +00:00
* `copyright`: copyright to display at bottom of page / article overrides the site `DEFAULT_COPYRIGHT` value
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.
2013-07-29 20:05:07 +00:00
* `modified` : a modified time
* `image` : a cover image for the article also used as icon in listings path relative to `static` directory
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Previews
---------
Update README.md add previews
2013-08-05 17:12:13 +00:00
A live preview of the theme can be seen on the blog [VoltaicIdeas](http://blog.voltaicideas.net).
Previews of the site main page are shown below as desktop and mobile (bonus print preview of article).
### Desktop Previews
![Index Page](previews/index.png)
![Article](previews/article.png)
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Update README.md add previews
2013-08-05 17:12:13 +00:00
### Mobile Previews
![Mobile Index](previews/index.mobile.png)
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Update README.md add previews
2013-08-05 17:12:13 +00:00
![Mobile Article](previews/article.mobile.png)
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Update README.md add previews
2013-08-05 17:12:13 +00:00
### Print Preview (print layout to be improved & disqus hidden)
![Print Article](previews/article.print.png)
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
Update README.md
2013-07-14 00:25:08 +00:00
TODO
-----
* Allow for multilevel MENUITEMS
Update README.md add previews
2013-08-05 17:12:13 +00:00
* Migrate some template hacks into pelican plugins
Update README.md
2013-07-14 00:25:08 +00:00
Update README.md mention prerelease status Updates the Readme to note that the code is not fully completed yet, in addition to a few minor edits.
2013-05-28 02:21:47 +00:00
Change-log ( Major Details )
Initial Commit Adds .gitattributes, .gitignore, and README.md as well as static\config.rb which is the compass configuration file for the sass (scss) style-sheets. The README.md is an initial version.
2013-05-24 11:31:52 +00:00
-------------------------
Update README.md add previews
2013-08-05 17:12:13 +00:00
* `v0.1.0` First Release <- Current
Copy Permalink