|
7 vuotta sitten | |
---|---|---|
previews | 7 vuotta sitten | |
static | 7 vuotta sitten | |
templates | 7 vuotta sitten | |
utils | 7 vuotta sitten | |
.gitattributes | 7 vuotta sitten | |
.gitignore | 7 vuotta sitten | |
LICENSE.md | 7 vuotta sitten | |
README.md | 7 vuotta sitten |
Pelican-red is a pelican theme designed to be readable on every device. It is a responsive layout which utilizes the Foundation 4 framework. The theme was originally created for the blog VoltaicIdeas (no longer using this theme) 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.
The following is a list of features:
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 ):
git clone https://github.com/arsenetar/pelican-red.git ~/pelican-red
or
wget https://github.com/arsenetar/pelican-red/archive/master.zip
unzip master.zip
mv pelican-red-master ~/pelican-red
The theme can then either be used by installing the theme or just by pointing to it.
Using pelican-themes (~/pelican-red is path to the theme used in previous example):
pelican-themes --install ~/pelican-red
Then change the theme in the Pelican settings file for the site you want to use pelican-red:
THEME = "pelican-red"
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):
THEME = "~/pelican-red"
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
SITE_DESCR
: Description of site used for meta if you wantSITE_KEY
: Keywords for meta ex. "keyword1, keyword2, keyword3"
FAVICON
: Path to favicon ex. images/favicon
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.COPYRIGHTS
: Copyright dictionary ['Abbreviation': ('name','url')]
cc
, cc-nc
, etc will generate iconified copyright linksDEFAULT_COPYRIGHT
: Default copyright to use is an abbreviation key from the COPYRIGHTS
dictionaryCOPYRIGHT_ARTICLE
: Show default copyright on articles (over-ridable with article value)COPYRIGHT_PAGE
: Show default copyright on pages (over-ridable with page value)COPYRIGHT_HOLDER
: set the holder of the copyright, defaults to AUTHOR
COPYRIGHT_YEAR
: set the copyright year, no default valueMENUITEMS
: 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.DISPLAY_ARCHIVE_ON_MENU
: True / False Show a link to the archive on the navigation menuINCLUDE_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
: List of the social links and urls ex. (('Network','url'),)
, supported w/icon listed below:
('blogger','http://myblog.blogspot.com')
('dribble','http://dribbble.com/username')
('facebook','http://www.facebook.com/username')
('flickr','http://www.flikr.com/photos/username')
('github','https://github.com/username')
('grooveshark','http://grooveshark.com/username')
('gplus','https://plus.google.com/profileID')
('instagram','http://instagram.com/username')
('lasstfm','http://www.last.fm/user/username')
('linkedin','http://www.linkedin.com/in/username')
('picasa','http://')
('pinterest','http://pinterest.com/username')
('rdio','http://www.rdio.com/people/username')
('reddit','http://www.reddit.com/user/username')
('skype','skype:username?chat')
('soudcloud','https://soundcloud.com/profileID')
('steam','http://steamcommunity.com/profiles/profileID')
('stumbleupon','http://www.stumbleupon.com/stumbler/username')
('tumblr','http://myblog.tumblr.com')
('twitter','http://twitter.com/username')
('vimeo','http://vimeo.com/channels/channelID')
('youtube','http://www.youtube.com/channel/channelID')
ARTICLES_ON_INDEX
: number of recent articles to showPAGES_ON_INDEX
: True / FalseDISQUS_SN
: Disqus Shortname of site ( VoltaicIdeas )COMMENTS_PAGE
: Include Comments on pages set True/FalseCOMMENTS_ARTICLE
: Include Comments on articles set True/FalseAUTHORS
: a dictionary of authors
vcard
: a tuple of tuples of author vcard values support includes (not limited though ):
fn
: Full Nameemail
: [email protected]photo
: url to an image about 150pxtitle
: Awesome Person, Blog Writer, etcorg
: some companynotes
: this can be a bio / anything reallysocial
: ((‘network’,‘link’),) same as SITE_SOCIAL parametersGOOGLE_ANALYTICS
: Google Analytics Code and Domain ex. ( UA-xxxxxxxx-x' , 'voltaicideas.net' )
GO_SQUARED
: GoSquared Code ex. 'GSN-xxxxxx-x'
GOOGLE_SEARCH
: set to the unique search id number “var cx = ‘this value’ "In addition to the additional configuration variables the theme supports the following variables in articles / pages.
comments
: show comments True/False overrides the site comments settingcopyright
: copyright to display at bottom of page / article overrides the site DEFAULT_COPYRIGHT
valuemodified
: a modified timeimage
: a cover image for the article also used as icon in listings path relative to static
directoryPreviews of the site main page are shown below as desktop and mobile (bonus print preview of article).
v0.1.0
First Release <- Current