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 6 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 @@
1
+# Auto detect text files and perform LF normalization
2
+* text=auto
3
+
4
+# Diff Settings
5
+*.html diff=html
6
+*.rb   diff=ruby

+ 42
- 0
.gitignore View File

@@ -0,0 +1,42 @@
1
+### Compass.app Ignore
2
+compass_app_log.txt
3
+
4
+### SASS Ignores - "Sassy CSS" http://sass-lang.com/
5
+*.sass-cache
6
+
7
+#############
8
+## Windows 
9
+#############
10
+
11
+# Windows image file caches
12
+Thumbs.db
13
+ehthumbs.db
14
+
15
+# Folder config file
16
+Desktop.ini
17
+
18
+# Recycle Bin used on file shares
19
+$RECYCLE.BIN/
20
+
21
+#############
22
+## OSX 
23
+#############
24
+.DS_Store
25
+.AppleDouble
26
+.LSOverride
27
+Icon
28
+
29
+# Thumbnails
30
+._*
31
+
32
+# Files that might appear on external disk
33
+.Spotlight-V100
34
+.Trashes
35
+
36
+#############
37
+## Linux
38
+#############
39
+.*
40
+!.gitignore
41
+!.gitattributes
42
+*~

+ 102
- 0
README.md View File

@@ -0,0 +1,102 @@
1
+Pelican-red
2
+============
3
+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.   
4
+
5
+Features ( EDIT THIS )
6
+---------
7
+The following is a list of features:
8
+
9
+* Responsive design viewable on mobile down to 380px wide without issue (article date issue atm)
10
+* Fixed top-bar w/drop-down navigation & social links
11
+    - Social links supported
12
+        - Google+
13
+        - Github
14
+        - Twitter
15
+        - LinkedIn
16
+        - more...   
17
+    - Hidden drop-down navigation
18
+        - accessed on hovering site name / menu icon
19
+        - fixed to 100% browser window height
20
+        - scroll-able?
21
+        - mobile version via swipe?   
22
+* Style-sheets built using sass & compass 
23
+* zeptos.js used instead of jQuery when possible
24
+* Analytics via Google Analytics or GoSquared 
25
+* Disqus comments support
26
+* pygments code highlighting
27
+- more...
28
+
29
+Install
30
+--------
31
+
32
+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):
33
+~~~
34
+git clone https:// ~/pelican-red
35
+~~~
36
+or
37
+~~~
38
+download zip url thingy
39
+extract
40
+~~~
41
+The theme can then either be used by installing the theme or just by pointing to it.
42
+
43
+#### Option 1 - Install
44
+Using pelican-themes (~/pelican-red is path to the theme used in previous example):
45
+~~~
46
+pelican-themes --install ~/pelican-red
47
+~~~
48
+Then change the theme in the Pelican settings file for the site you want to use pelican-red:
49
+~~~
50
+THEME = "pelican-red"
51
+~~~
52
+
53
+### Option 2 - Just Point to It
54
+
55
+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):
56
+~~~
57
+THEME = "~/pelican-red"
58
+~~~
59
+
60
+Configuration
61
+--------------
62
+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.
63
+
64
+Variables are listed as `variable` : description
65
+
66
+### General
67
+* `SITE_DESCR`: Description of site used for meta if you want
68
+* `SITE_KEY`: Keywords for meta ex. `"keyword1, keyword2, keyword3"`
69
+
70
+### Social
71
+* TODO
72
+
73
+### Comments ( Disqus )
74
+* `DISQUS_SN`: Disqus Shortname of site ( rangertbc )
75
+
76
+### Analytics ( Google Analytics and GoSquared )
77
+* `GA_CODE`: Google Analytics Code ( UA-xxxxxxxx-x )
78
+* `GA_DOMAIN`: Google Analytics Domain for use across sub-domains of a top level domain ( rangertbc.net )
79
+* `GA_LINKER`: Google Analytics multiple top level domains set to True if wanted ( rangertbc.net, rangertbc.com, etc )
80
+* `GS_CODE`: GoSquared Code ( GSN-xxxxxx-x )
81
+
82
+Per Post / Page Variables
83
+--------------------------
84
+In addition to the additional configuration variables the theme supports the following variables in posts / pages.
85
+
86
+* TODO
87
+
88
+Previews
89
+---------
90
+A live preview of the theme can be seen on my blog [rangerTBC](http://rangertbc.net). 
91
+
92
+Previews of the site main page are shown below as desktop and mobile.
93
+
94
+### Desktop Preview
95
+INSERT SITE PREVIEW 
96
+
97
+### Mobile Preview
98
+INSERT MOBILE PREVIEW
99
+
100
+Change-log ( Major Only)
101
+-------------------------
102
+* `0.1.0` First Release

+ 25
- 0
static/config.rb View File

@@ -0,0 +1,25 @@
1
+# Require any additional compass plugins here.
2
+
3
+# Set this to the root of your project when deployed:
4
+http_path = "/"
5
+css_dir = "css"
6
+sass_dir = "sass"
7
+images_dir = "images"
8
+javascripts_dir = "js"
9
+fonts_dir = "fonts"
10
+
11
+# You can select your preferred output style here (can be overridden via the command line):
12
+output_style = :compact #or :compressed
13
+
14
+# To enable relative paths to assets via compass helper functions. Uncomment:
15
+# relative_assets = true
16
+
17
+# To disable debugging comments that display the original location of your selectors. Uncomment:
18
+line_comments = false
19
+
20
+# If you prefer the indented syntax, you might want to regenerate this
21
+# project again passing --syntax sass, or you can uncomment this:
22
+# preferred_syntax = :sass
23
+# and then run:
24
+# sass-convert -R --from scss --to sass sass scss && rm -rf sass && mv scss sass
25
+preferred_syntax = :scss

Loading…
Cancel
Save