Browse Source

Update README.md add previews

master
Andrew Senetar 6 years ago
parent
commit
c8803ae2d9
6 changed files with 28 additions and 15 deletions
  1. 28
    15
      README.md
  2. BIN
      previews/article.mobile.png
  3. BIN
      previews/article.png
  4. BIN
      previews/article.print.png
  5. BIN
      previews/index.mobile.png
  6. BIN
      previews/index.png

+ 28
- 15
README.md View File

@@ -1,15 +1,13 @@
1 1
 Pelican-red
2 2
 ============
3 3
 
4
-**Beta Quality Pre-v0.1.0**
5
-
6 4
 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.     
7 5
 
8 6
 Features
9 7
 ---------
10 8
 The following is a list of features:
11 9
 
12
-* Responsive design view-able on mobile down to about 230px wide
10
+* Responsive design view-able on mobile down to about 300px wide
13 11
 * Top-bar w/drop-down navigation & social links
14 12
     * 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 ):
15 13
         * Blogger ( Zocial )
@@ -38,16 +36,17 @@ The following is a list of features:
38 36
 * zeptos.js used instead of jQuery when possible
39 37
 * Javascript files loaded via [yepnope.js](http://yepnopejs.com/) (part of modernizr) from CDN [jsDelivr](http://www.jsdelivr.com/) with local fallback
40 38
 * Analytics via Google Analytics ( new version ) or GoSquared 
41
-* Disqus comments support **(TODO FINISH)** 
42
-* PDF link support
39
+* Disqus comments support  
43 40
 * pygments code highlighting with responsive layout
44 41
 * Site Icons for Creative Commons Licenses, VCards, Tags, PDF download, Search, and Translation selection using [Entypo](http://www.entypo.com) by Daniel Bruce
45
-* Google Custom Search Support
42
+* Google Custom Search Support (works with overlay)
46 43
 * Open Sans used for style font
47 44
 * Source Code Pro used for code blocks
45
+* Vcards (hcards) and micro-formatting for articles, pages, and authors
48 46
 * Supports the following pelican-plugins (plus others):
49 47
   * multi_part
50 48
   * neighbors
49
+  * related_posts
51 50
 
52 51
 Install
53 52
 --------
@@ -91,16 +90,23 @@ Variables are listed as `variable` : description
91 90
 * `SITE_DESCR`: Description of site used for meta if you want
92 91
 * `SITE_KEY`: Keywords for meta ex. `"keyword1, keyword2, keyword3"`
93 92
 * `FAVICON`: Path to favicon ex. `images/favicon`
93
+* `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.
94
+
95
+### Copyright
94 96
 * `COPYRIGHTS`: Copyright dictionary `['Abbreviation': ('name','url')]`
95 97
   * using `cc`, `cc-nc`, etc will generate iconified copyright links
96 98
 * `DEFAULT_COPYRIGHT` : Default copyright to use is an abbreviation key from the `COPYRIGHTS` dictionary 
97 99
 * `COPYRIGHT_ARTICLE` : Show default copyright on articles (over-ridable with article value)
98 100
 * `COPYRIGHT_PAGE` : Show default copyright on pages (over-ridable with page value)
101
+* `COPYRIGHT_HOLDER` : set the holder of the copyright, defaults to `AUTHOR`
102
+* `COPYRIGHT_YEAR` : set the copyright year, no default value
103
+
99 104
 
100 105
 ### Navigation
101 106
 * `MENUITEMS`: Custom Links to place in the menu e. `(('Item', 'Link'))`
102 107
 * `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.
103 108
 * `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.
109
+* `DISPLAY_ARCHIVE_ON_MENU` : True / False Show a link to the archive on the navigation menu
104 110
 
105 111
 ### Sidebar
106 112
 * `INCLUDE_TAGS_LINK` : True / False Include link to tags page on sidebar.
@@ -142,7 +148,7 @@ Variables are listed as `variable` : description
142 148
 * `COMMENTS_PAGE`: Include Comments on pages set True/False
143 149
 * `COMMENTS_ARTICLE`: Include Comments on articles set True/False
144 150
 
145
-### Authors ( vcards )
151
+### Authors ( vcards / hcards ) w/ microformats
146 152
 * `AUTHORS` : a dictionary of authors
147 153
   * `vcard` : a tuple of tuples of author vcard values support includes (not limited though ):
148 154
     * `fn` : Full Name
@@ -171,21 +177,28 @@ In addition to the additional configuration variables the theme supports the fol
171 177
 
172 178
 Previews
173 179
 ---------
174
-A live preview of the theme can be seen on the blog [VoltaicIdeas](http://blog.voltaicideas.net) as well as the gh-pages for pelican-red at [http://pelican-red.voltaicideas.net/](http:///pelican-red.voltaicideas.net). 
180
+A live preview of the theme can be seen on the blog [VoltaicIdeas](http://blog.voltaicideas.net). 
181
+
182
+Previews of the site main page are shown below as desktop and mobile (bonus print preview of article).
183
+
184
+### Desktop Previews
185
+![Index Page](previews/index.png)
186
+
187
+![Article](previews/article.png)
175 188
 
176
-Previews of the site main page are shown below as desktop and mobile.
189
+### Mobile Previews
190
+![Mobile Index](previews/index.mobile.png)
177 191
 
178
-### Desktop Preview
179
-INSERT SITE PREVIEW(s)
192
+![Mobile Article](previews/article.mobile.png)
180 193
 
181
-### Mobile Preview
182
-INSERT MOBILE PREVIEW(s)
194
+### Print Preview (print layout to be improved & disqus hidden)
195
+![Print Article](previews/article.print.png)
183 196
 
184 197
 TODO
185 198
 -----
186 199
 * Allow for multilevel MENUITEMS
187
-* Translations support (pages and articles)
200
+* Migrate some template hacks into pelican plugins
188 201
 
189 202
 Change-log ( Major Details )
190 203
 -------------------------
191
-* `v0.1.0` First Release
204
+* `v0.1.0` First Release <- Current

BIN
previews/article.mobile.png View File


BIN
previews/article.png View File


BIN
previews/article.print.png View File


BIN
previews/index.mobile.png View File


BIN
previews/index.png View File


Loading…
Cancel
Save