archive
/
pelican-mg
mirror of https://github.com/c0de-archive/pelican-mg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adding .pre-commit-config.yaml

This commit is contained in:
Lucas Cimon 2017-08-10 18:30:29 +02:00
parent 6c0b67a3c6
commit 29e3d34afe
15 changed files with 141 additions and 131 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
.pre-commit-config.yaml Executable file
View File

@ -0,0 +1,34 @@
- repo: git://github.com/pre-commit/pre-commit-hooks
sha: v0.9.1
hooks:
- id: check-merge-conflict
- id: trailing-whitespace
args:
- --no-markdown-linebreak-ext
- repo: git://github.com/Lucas-C/pre-commit-hooks
sha: v1.0.1
hooks:
- id: remove-crlf
exclude: npp/.*\.xml
- id: remove-tabs
- repo: https://github.com/Lucas-C/pre-commit-hooks-html
sha: v1.2.1
hooks:
- id: validate-html
args:
- --remove-mustaches
- --mustache-remover=jinja2
- --templates-include-dir=templates
- "--ignore=Expected \"<!DOCTYPE html>\""
- "--ignore=Element \"title\" must not be empty"
- "--ignore=Element \"head\" is missing a required instance of child element \"title\""
- "--ignore=The \"itemprop\" attribute was specified, but the element is not a property of any item"
- "--ignore=Bad value \"DUMMY\" for attribute \"datetime\""
exclude: templates/tipue_search.html
- repo: local
hooks:
- id: make
name: make
language: system
entry: make
files: ''

44
README.md
View File

@ -6,7 +6,7 @@ The theme is suited for a single author blog without tag pages nor
blogroll. Feeds are provided via ATOM.
Screenshots
Screenshots
--------------
Here is how the home page look like
@ -17,7 +17,7 @@ This is the article page
![mg article page screenshot](https://raw.githubusercontent.com/lucachr/pelican-mg/master/article-screenshot.png)
The home page on a smartphone
The home page on a smartphone
![mg home page smartphone top screenshot](https://github.com/lucachr/pelican-mg/blob/master/home-page-smartphone-top.png)
![mg home page smartphone bottom screenshot](https://github.com/lucachr/pelican-mg/blob/master/home-page-smartphone-bottom.png)
@ -69,47 +69,47 @@ If you want to use mg with search disabled.
###Optional settings
**ALT_NAME**
**ALT_NAME**
An alternative name for your site. It appears in the header bar.
**DESCRIPTION**
**DESCRIPTION**
A brief description of your site, for social networks and search engines.
**DISABLE_SEARCH**
**DISABLE_SEARCH**
Disable search, boolean.
**FAVICON**
**FAVICON**
The relative path of your favicon, this is needed for Disqus forum favicon.
**FAVICON_TYPE**
**FAVICON_TYPE**
The MIME type of your favicon, this is needed for Disqus forum favicon.
**FOOTER**
**FOOTER**
A custom footer notice.
**META_IMAGE**
The absolute URL of a custom image for the `og:image` meta property, Twitter
summary card, and `image` meta property of Schema.org. This image is used in
every page of the blog. Articles and pages can override the default
**META_IMAGE** by setting the "image" metadata in the relative file.
**META_IMAGE**
The absolute URL of a custom image for the `og:image` meta property, Twitter
summary card, and `image` meta property of Schema.org. This image is used in
every page of the blog. Articles and pages can override the default
**META_IMAGE** by setting the "image" metadata in the relative file.
**META_IMAGE_TYPE**
**META_IMAGE_TYPE**
The MIME type for **META_IMAGE**, this is needed for `og:image:type`.
**SC_PROJECT**
The StatCounter project number.
**SC_PROJECT**
The StatCounter project number.
**SC_SECURITY**
**SC_SECURITY**
The StatCounter security code for the project.
**SHARE**
**SHARE**
Enable share buttons, boolean.
**SOCIAL**
**SOCIAL**
A list of tuples (icon, URL). The icons are from [Font Awesome]
(http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is removed
in the footer icons of the small screen layout.
e.g.
(http://fortawesome.github.io/Font-Awesome/). The suffix "-square" is removed
in the footer icons of the small screen layout.
e.g.
```python
SOCIAL = (('twitter', 'https://twitter.com/luca_chr'),
('google-plus-square', 'https://plus.google.com/117284397605208270870'),

10
scss/tipuesearch.scss
View File

@ -6,7 +6,7 @@
*
* This is a modified version of the Tipue Search plugin style sheet,
* edited for the pelican mg theme.
* If you are looking for the original Tipue Search plugin style sheet
* If you are looking for the original Tipue Search plugin style sheet
* check the project home at http://www.tipue.com/search.
*/
@ -26,7 +26,7 @@ $baseText: #444;
}
#tipue_search_loading:before {
padding-top: 60px;
padding-top: 60px;
font-family: FontAwesome;
content: "\f013";
background: #fff no-repeat left;
@ -51,7 +51,7 @@ $baseText: #444;
}
#tipue_search_warning a:hover {
color: #333;
color: #333;
}
.tipue_search_content_title {
@ -60,13 +60,13 @@ $baseText: #444;
font-weight: 400;
text-transform: none;
margin-top: 0.5em;
}
}
.tipue_search_content_title a {
color: $baseText;
text-decoration: none;
&:hover {
color: $baseText;
color: $baseText;
text-decoration: underline;
}
}

4
static/css/solarized.css
View File

@ -12,7 +12,7 @@
* cyan #2aa198 strings, numbers
* green #859900 operators, other keywords
* */
.highlight { background-color: #fdf6e3; color: #586e75 }
.highlight .c { color: #93a1a1 } /* Comment */
.highlight .err { color: #586e75 } /* Error */
@ -81,4 +81,4 @@
.highlight .vc { color: #268bd2 } /* Name.Variable.Class */
.highlight .vg { color: #268bd2 } /* Name.Variable.Global */
.highlight .vi { color: #268bd2 } /* Name.Variable.Instance */
.highlight .il { color: #2aa198 } /* Literal.Number.Integer.Long */
.highlight .il { color: #2aa198 } /* Literal.Number.Integer.Long */

2
static/css/tipuesearch.css
View File

@ -6,7 +6,7 @@
*
* This is a modified version of the Tipue Search plugin style sheet,
* edited for the pelican mg theme.
* If you are looking for the original Tipue Search plugin style sheet
* If you are looking for the original Tipue Search plugin style sheet
* check the project home at http://www.tipue.com/search.
*/
#tipue_search_content {

130
static/js/tipuesearch.js
View File

@ -4,7 +4,7 @@ Tipue Search 4.0
Copyright (c) 2014 Tipue
Tipue Search is released under the MIT License
http://www.tipue.com/search
*/
*/
(function($) {
@ -12,7 +12,7 @@ http://www.tipue.com/search
$.fn.tipuesearch = function(options) {
var set = $.extend( {
'show' : 7,
'newWindow' : false,
'showURL' : true,
@ -24,9 +24,9 @@ http://www.tipue.com/search
'liveDescription' : '*',
'liveContent' : '*',
'contentLocation' : 'tipuesearch/tipuesearch_content.json'
}, options);
return this.each(function() {
var tipuesearch_in = {
@ -47,7 +47,7 @@ http://www.tipue.com/search
cont = cont.replace(/\s+/g, ' ');
var desc = $(set.liveDescription, html).text();
desc = desc.replace(/\s+/g, ' ');
var t_1 = html.toLowerCase().indexOf('<title>');
var t_2 = html.toLowerCase().indexOf('</title>', t_1 + 7);
if (t_1 != -1 && t_2 != -1)
@ -63,13 +63,13 @@ http://www.tipue.com/search
"title": tit,
"text": desc,
"tags": cont,
"loc": tipuesearch_pages[i]
});
"loc": tipuesearch_pages[i]
});
}
);
}
}
if (set.mode == 'json')
{
$.getJSON(set.contentLocation,
@ -83,12 +83,12 @@ http://www.tipue.com/search
if (set.mode == 'static')
{
tipuesearch_in = $.extend({}, tipuesearch);
}
}
var tipue_search_w = '';
if (set.newWindow)
{
tipue_search_w = ' target="_blank"';
tipue_search_w = ' target="_blank"';
}
function getURLP(name)
@ -99,8 +99,8 @@ http://www.tipue.com/search
{
$('.tipue_search')[0].val(getURLP('q'));
getTipueSearch(0, true);
}
}
$(this).keyup(function(event)
{
if(event.keyCode == '13')
@ -119,15 +119,15 @@ http://www.tipue.com/search
var standard = true;
var c = 0;
found = new Array();
var d = $('.tipue_search')[0].val().toLowerCase();
d = $.trim(d);
if ((d.match("^\"") && d.match("\"$")) || (d.match("^'") && d.match("'$")))
{
standard = false;
}
if (standard)
{
var d_w = d.split(' ');
@ -140,7 +140,7 @@ http://www.tipue.com/search
if (d_w[i] == tipuesearch_stop_words[f])
{
a_w = false;
show_stop = true;
show_stop = true;
}
}
if (a_w)
@ -155,7 +155,7 @@ http://www.tipue.com/search
{
d = d.substring(1, d.length - 1);
}
if (d.length >= set.minimumLength)
{
if (standard)
@ -175,8 +175,8 @@ http://www.tipue.com/search
}
}
d_w = d.split(' ');
}
}
var d_t = d;
for (var i = 0; i < d_w.length; i++)
{
@ -205,10 +205,10 @@ http://www.tipue.com/search
{
score -= (150000 - i);
}
if (set.highlightTerms)
{
if (set.highlightEveryTerm)
if (set.highlightEveryTerm)
{
var patr = new RegExp('(' + d_w[f] + ')', 'gi');
}
@ -222,20 +222,20 @@ http://www.tipue.com/search
{
score -= (100000 - i);
}
if (d_w[f].match("^-"))
{
pat = new RegExp(d_w[f].substring(1), 'i');
if (tipuesearch_in.pages[i].title.search(pat) != -1 || tipuesearch_in.pages[i].text.search(pat) != -1 || tipuesearch_in.pages[i].tags.search(pat) != -1)
{
score = 1000000000;
}
score = 1000000000;
}
}
}
if (score < 1000000000)
{
found[c++] = score + '^' + tipuesearch_in.pages[i].title + '^' + s_t + '^' + tipuesearch_in.pages[i].loc;
found[c++] = score + '^' + tipuesearch_in.pages[i].title + '^' + s_t + '^' + tipuesearch_in.pages[i].loc;
}
}
}
@ -254,10 +254,10 @@ http://www.tipue.com/search
{
score -= (150000 - i);
}
if (set.highlightTerms)
{
if (set.highlightEveryTerm)
if (set.highlightEveryTerm)
{
var patr = new RegExp('(' + d + ')', 'gi');
}
@ -271,20 +271,20 @@ http://www.tipue.com/search
{
score -= (100000 - i);
}
if (score < 1000000000)
{
found[c++] = score + '^' + tipuesearch_in.pages[i].title + '^' + s_t + '^' + tipuesearch_in.pages[i].loc;
}
found[c++] = score + '^' + tipuesearch_in.pages[i].title + '^' + s_t + '^' + tipuesearch_in.pages[i].loc;
}
}
}
}
if (c != 0)
{
if (show_replace == 1)
{
out += '<div id="tipue_search_warning_head">Showing results for ' + d + '</div>';
out += '<div id="tipue_search_warning">Search instead for <a href="javascript:void(0)" id="tipue_search_replaced">' + d_r + '</a></div>';
out += '<div id="tipue_search_warning">Search instead for <a href="javascript:void(0)" id="tipue_search_replaced">' + d_r + '</a></div>';
}
if (c == 1)
{
@ -295,21 +295,21 @@ http://www.tipue.com/search
c_c = c.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ",");
out += '<div id="tipue_search_results_count">' + c_c + ' results</div>';
}
found.sort();
var l_o = 0;
for (var i = 0; i < found.length; i++)
{
var fo = found[i].split('^');
if (l_o >= start && l_o < set.show + start)
{
{
out += '<div class="tipue_search_content_title"><a href="' + fo[3] + '"' + tipue_search_w + '>' + fo[1] + '</a></div>';
if (set.showURL)
{
{
out += '<div class="tipue_search_content_url"><a href="' + fo[3] + '"' + tipue_search_w + '>' + fo[3] + '</a></div>';
}
var t = fo[2];
var t_d = '';
var t_w = t.split(' ');
@ -321,7 +321,7 @@ http://www.tipue.com/search
{
for (var f = 0; f < set.descriptiveWords; f++)
{
t_d += t_w[f] + ' ';
t_d += t_w[f] + ' ';
}
}
t_d = $.trim(t_d);
@ -331,27 +331,27 @@ http://www.tipue.com/search
}
out += '<div class="tipue_search_content_text">' + t_d + '</div>';
}
l_o++;
l_o++;
}
if (c > set.show)
{
var pages = Math.ceil(c / set.show);
var page = (start / set.show);
out += '<div id="tipue_search_foot"><ul id="tipue_search_foot_boxes">';
if (start > 0)
{
out += '<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="' + (start - set.show) + '_' + replace + '">Prev</a></li>';
out += '<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="' + (start - set.show) + '_' + replace + '">Prev</a></li>';
}
if (page <= 2)
{
var p_b = pages;
if (pages > 3)
{
p_b = 3;
}
}
for (var f = 0; f < p_b; f++)
{
if (f == page)
@ -369,7 +369,7 @@ http://www.tipue.com/search
var p_b = page + 2;
if (p_b > pages)
{
p_b = pages;
p_b = pages;
}
for (var f = page - 1; f < p_b; f++)
{
@ -382,26 +382,26 @@ http://www.tipue.com/search
out += '<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="' + (f * set.show) + '_' + replace + '">' + (f + 1) + '</a></li>';
}
}
}
}
if (page + 1 != pages)
{
out += '<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="' + (start + set.show) + '_' + replace + '">Next</a></li>';
}
out += '<li><a href="javascript:void(0)" class="tipue_search_foot_box" id="' + (start + set.show) + '_' + replace + '">Next</a></li>';
}
out += '</ul></div>';
}
}
}
else
{
out += '<div id="tipue_search_warning_head">Nothing found</div>';
out += '<div id="tipue_search_warning_head">Nothing found</div>';
}
}
else
{
if (show_stop)
{
out += '<div id="tipue_search_warning_head">Nothing found</div><div id="tipue_search_warning">Common words are largely ignored</div>';
out += '<div id="tipue_search_warning_head">Nothing found</div><div id="tipue_search_warning">Common words are largely ignored</div>';
}
else
{
@ -416,27 +416,27 @@ http://www.tipue.com/search
}
}
}
$('#tipue_search_content').html(out);
$('#tipue_search_content').slideDown(200);
$('#tipue_search_replaced').click(function()
{
getTipueSearch(0, false);
});
});
$('.tipue_search_foot_box').click(function()
{
var id_v = $(this).attr('id');
var id_a = id_v.split('_');
getTipueSearch(parseInt(id_a[0]), id_a[1]);
});
}
});
}
});
};
})(jQuery);

6
templates/analytics.html
View File

@ -31,9 +31,9 @@ ga('create','{{ GOOGLE_ANALYTICS }}');ga('send','pageview');
{% if SC_PROJECT and SC_SECURITY %}
<!-- Start of StatCounter Code for Default Guide -->
<script type="text/javascript">
var sc_project={{ SC_PROJECT }};
var sc_invisible=1;
var sc_security="{{ SC_SECURITY }}";
var sc_project={{ SC_PROJECT }};
var sc_invisible=1;
var sc_security="{{ SC_SECURITY }}";
var scJsHost = (("https:" == document.location.protocol) ?
"https://secure." : "http://www.");
document.write("<sc"+"ript type='text/javascript' src='" +

2
templates/archives.html
View File

@ -2,8 +2,6 @@
{% block title %}Archives{% endblock %}
{% block description %}{% endblock %}
{% include 'common_seo.html' %}
{% block content %}
<div class="uk-width-medium-4-5">
<h1 class="uk-heading-large">Archives</h1>

6
templates/categories.html
View File

@ -1,9 +1,7 @@
{% extends "base.html" %}
{% block title %}Categories{% endblock %}
{% block title %}Categories{% endblock %}
{% block description %}{% endblock %}
{% include 'common_seo.html' %}
{% block content %}
<div class="uk-width-medium-4-5">
<h1 class="uk-heading-large">Categories</h1>
@ -18,7 +16,7 @@
</p>
<p>{{ ' '.join(article.content.split(' ')[0:75])|striptags }}...</p>
</article>
{% endfor %}
<hr>

2
templates/category.html
View File

@ -1,5 +1,3 @@
{% extends "index.html" %}
{% block title %}{{ category|capitalize }}{% endblock %}
{% block description %}{% endblock %}
{% include 'common_seo.html' %}

16
templates/common_seo.html
View File

@ -1,16 +0,0 @@
{% block seo %}
<meta property="og:title" content="{{ SITENAME }}" />
<meta property="og:type" content="website" />
<meta property="og:url" content="{{ SITEURL }}" />
<meta name="twitter:url" content="{{ SITEURL }}" />
<meta itemprop="name" content="{{ SITENAME }}">
<meta itemprop="url" content="{{ SITEURL }}">
{% if META_IMAGE %}
<meta property="og:image" content="{{ META_IMAGE }}" />
<meta property="og:image:type" content="{{ META_IMAGE_TYPE }}" />
<meta name="twitter:image" content="{{ META_IMAGE }}" />
<meta itemprop="image" content="{{ META_IMAGE }}"/>
{% endif %}
{% endblock %}

4
templates/page.html
View File

@ -25,10 +25,10 @@
{% endif %}
{% endblock %}
{% block content %}
{% block content %}
<div class="uk-width-medium-4-5">
<h1 class="uk-heading-large" itemprop="name">{{ page.title }}</h1>
{% block page_content %}
{% endblock %}

2
templates/partials/article-short.html
View File

@ -3,7 +3,7 @@
<p class="uk-article-meta"><time datetime="{{ article.date.strftime('%Y-%m-%d') }}" itemprop="datePublished">{{ article.locale_date }}</time> • <a href="{{ SITEURL }}/{{ article.category.url }}">{{ article.category }}</a>{% if DISQUS_SITENAME %} • <br class="uk-visible-small"><i class="uk-icon-comment"></i> <a href="{{ SITEURL }}/{{ article.url }}#disqus_thread" itemprop="discussionUrl"></a>{% endif %}</p>
<!--{{ article.summary }}-->
<p class="uk-article-lead" itemprop="description">{{ article.summary|striptags|striptags }}</p>
{% if not MG_DISABLE_SUMMARY %}<p>{{ ' '.join(article.content.split(' ')[:SUMMARY_MAX_LENGTH ])|striptags|striptags }}...</p>{% endif %}
{% if not MG_DISABLE_SUMMARY %}<p>{{ ' '.join(article.content.split(' ')[:SUMMARY_MAX_LENGTH])|striptags|striptags }}...</p>{% endif %}
<a href="{{ SITEURL }}/{{ article.url }}">Read More</a>
{% include "partials/inline-tags.html" %}
<hr class="uk-article-divider">

2
templates/search.html
View File

@ -2,8 +2,6 @@
{% block title %}Search results{% endblock %}
{% block description %}{% endblock %}
{% include 'common_seo.html' %}
{% block content %}
<div class="uk-width-medium-4-5">
<h1 class="uk-heading-large">Search results</h1>

8
templates/tipue_search.html
View File

@ -3,13 +3,13 @@
{% set len = (articles + pages)| length %}
{% for item in articles + pages %}
{
"title": "{{item.title|striptags|e}}",
"text":"{{item.content|striptags|e}}",
"tags": "{{item.category}}",
"title": "{{item.title|striptags|e}}",
"text":"{{item.content|striptags|e}}",
"tags": "{{item.category}}",
"loc": "{{ SITEURL }}/{{item.url}}"
}{% if loop.index < len %},
{% else %}
{% endif %}
{% endfor %}
]