Browse Source

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.
master
Andrew Senetar 7 years ago
commit
d1087733af
4 changed files with 175 additions and 0 deletions
  1. 6
    0
      .gitattributes
  2. 42
    0
      .gitignore
  3. 102
    0
      README.md
  4. 25
    0
      static/config.rb

+ 6
- 0
.gitattributes View File

@@ -0,0 +1,6 @@
# Auto detect text files and perform LF normalization
* text=auto

# Diff Settings
*.html diff=html
*.rb diff=ruby

+ 42
- 0
.gitignore View File

@@ -0,0 +1,42 @@
### Compass.app Ignore
compass_app_log.txt

### SASS Ignores - "Sassy CSS" http://sass-lang.com/
*.sass-cache

#############
## Windows
#############

# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

#############
## OSX
#############
.DS_Store
.AppleDouble
.LSOverride
Icon

# Thumbnails
._*

# Files that might appear on external disk
.Spotlight-V100
.Trashes

#############
## Linux
#############
.*
!.gitignore
!.gitattributes
*~

+ 102
- 0
README.md View File

@@ -0,0 +1,102 @@
Pelican-red
============
Pelican-red is a [pelican](http://getpelican.com) theme originally created for my blog [rangerTBC](http://rangertbc.net). I have added some additional features to what I required and am releasing it for anyone to use. The theme is responsive using the [Foundation 4](http://foundation.zurb.com/) framework as a base.

Features ( EDIT THIS )
---------
The following is a list of features:

* Responsive design viewable on mobile down to 380px wide without issue (article date issue atm)
* Fixed top-bar w/drop-down navigation & social links
- Social links supported
- Google+
- Github
- Twitter
- LinkedIn
- more...
- Hidden drop-down navigation
- accessed on hovering site name / menu icon
- fixed to 100% browser window height
- scroll-able?
- mobile version via swipe?
* Style-sheets built using sass & compass
* zeptos.js used instead of jQuery when possible
* Analytics via Google Analytics or GoSquared
* Disqus comments support
* pygments code highlighting
- more...

Install
--------

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:// ~/pelican-red
~~~
or
~~~
download zip url thingy
extract
~~~
The theme can then either be used by installing the theme or just by pointing to it.

#### Option 1 - Install
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"
~~~

### 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):
~~~
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"`

### Social
* TODO

### Comments ( Disqus )
* `DISQUS_SN`: Disqus Shortname of site ( rangertbc )

### Analytics ( Google Analytics and GoSquared )
* `GA_CODE`: Google Analytics Code ( UA-xxxxxxxx-x )
* `GA_DOMAIN`: Google Analytics Domain for use across sub-domains of a top level domain ( rangertbc.net )
* `GA_LINKER`: Google Analytics multiple top level domains set to True if wanted ( rangertbc.net, rangertbc.com, etc )
* `GS_CODE`: GoSquared Code ( GSN-xxxxxx-x )

Per Post / Page Variables
--------------------------
In addition to the additional configuration variables the theme supports the following variables in posts / pages.

* TODO

Previews
---------
A live preview of the theme can be seen on my blog [rangerTBC](http://rangertbc.net).

Previews of the site main page are shown below as desktop and mobile.

### Desktop Preview
INSERT SITE PREVIEW

### Mobile Preview
INSERT MOBILE PREVIEW

Change-log ( Major Only)
-------------------------
* `0.1.0` First Release

+ 25
- 0
static/config.rb View File

@@ -0,0 +1,25 @@
# Require any additional compass plugins here.

# Set this to the root of your project when deployed:
http_path = "/"
css_dir = "css"
sass_dir = "sass"
images_dir = "images"
javascripts_dir = "js"
fonts_dir = "fonts"

# You can select your preferred output style here (can be overridden via the command line):
output_style = :compact #or :compressed

# To enable relative paths to assets via compass helper functions. Uncomment:
# relative_assets = true

# To disable debugging comments that display the original location of your selectors. Uncomment:
line_comments = false

# If you prefer the indented syntax, you might want to regenerate this
# project again passing --syntax sass, or you can uncomment this:
# preferred_syntax = :sass
# and then run:
# sass-convert -R --from scss --to sass sass scss && rm -rf sass && mv scss sass
preferred_syntax = :scss

Loading…
Cancel
Save