Skip to content

Commit

Permalink
Merge pull request #8 from karlstolley/source-formatting
Browse files Browse the repository at this point in the history
Took a minute, but looks good.
  • Loading branch information
elotroalex committed Jan 16, 2019
2 parents 2e94c12 + ade77a6 commit ca45b08
Show file tree
Hide file tree
Showing 34 changed files with 417 additions and 436 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ _gh_pages
_site
.ruby-version


# Numerous always-ignore extensions
*.diff
*.err
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ env:

sudo: false # route your build to the container-based infrastructure for a faster build

cache: bundler
cache: bundler
1 change: 0 additions & 1 deletion 404.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ permalink: 404.html
# 404: Page not found

Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. [Head back home]({{ site.baseurl }}) to try finding it again.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Ed is a [Jekyll](https://jekyllrb.com/) theme designed for textual editors based

One of our most pressing and ever revolving needs as scholars is to pass on our textual artifacts from one generation to another. The art of textual editing, among other practices, has helped many cultures to remember and interpret for centuries. Alas, that art is practiced and encouraged in its highest form by a dwindling number of scholars. In a digital environment the problem is compounded by the difficulties of the medium. While vast repositories, and "e-publications" appear on the online scene yearly, very few manifest a textual scholar's disciplined attention to detail. In contrast, most textual scholars who have made the leap to a rigorous digital practice have focused on markup, relying on technical teams to deploy and maintain their work. This makes your average scholarly digital edition a very costly, and therefore limited affair.

As we see it, a minimal edition is one that aims to reduce the size and complexity of the back and front end, and the learning curves for the user and the producer. Out of-the-box, this theme can help you build a simple reading edition, or a traditional scholarly edition with footnotes and a bibliography without breaking the bank. In our estimate, these are the two most immediately useful type of editions for editors and readers. An edition produced with Ed consists of static pages whose rate of decay is substantially lower than database-driven systems. As an added bonus, these static pages require less bandwith. Our hope is that our approach can help beginners or veterans deploy beautiful editions with less effort, that it can help us teach a 'full stack' [in one academic semester](https://github.com/susannalles/MinimalEditions/blob/master/index.md), allow us to care for our projects at less cost, and perhaps, just perhaps, allow us to generate high-quality editions on github.io in large quantities based on the [git-lit](http://jonreeve.com/2015/09/introducing-git-lit/) model by Jonathan Reeve. We're coming for you, Kindle!
As we see it, a minimal edition is one that aims to reduce the size and complexity of the back and front end, and the learning curves for the user and the producer. Out of-the-box, this theme can help you build a simple reading edition, or a traditional scholarly edition with footnotes and a bibliography without breaking the bank. In our estimate, these are the two most immediately useful type of editions for editors and readers. An edition produced with Ed consists of static pages whose rate of decay is substantially lower than database-driven systems. As an added bonus, these static pages require less bandwith. Our hope is that our approach can help beginners or veterans deploy beautiful editions with less effort, that it can help us teach a 'full stack' [in one academic semester](https://github.com/susannalles/MinimalEditions/blob/master/index.md), allow us to care for our projects at less cost, and perhaps, just perhaps, allow us to generate high-quality editions on github.io in large quantities based on the [git-lit](http://jonreeve.com/2015/09/introducing-git-lit/) model by Jonathan Reeve. We're coming for you, Kindle!


## Sample Ed editions.
Expand Down
7 changes: 2 additions & 5 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@ author:
url: https://twitter.com/elotroalex
email: colibri.alex@gmail.com

# Permalinks

# Color scheme. Options: red, orange, magenta, cyan, blue, brown
color-scheme:
color-scheme:

# Permalinks
permalink: pretty
permalink: /:title/

Expand Down Expand Up @@ -48,5 +47,3 @@ exclude:

# Theme
theme: "ed."


46 changes: 22 additions & 24 deletions _includes/head.html
Original file line number Diff line number Diff line change
@@ -1,47 +1,46 @@
<head>
<!-- Canonical link to help search engines -->
<link rel="canonical" href="{{ site.baseurl }}{{ page.url }}"/>
<link rel="canonical" href="{{ site.baseurl }}{{ page.url }}" />

<!-- Basic meta elements -->
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />

<!-- Enable responsiveness on mobile devices-->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1"/>
<!-- Enable responsiveness on mobile devices -->
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1" />

<!-- Dublin Core metadata for Zotero -->
<!-- Dublin Core metadata for Zotero -->
<meta name="DC.title" content="{{ page.title }}" />
<meta name="DC.creator" content="{{ page.author }}" />
<meta name="DC.contributor" content="{{ page.editor }}" />
<meta name="DC.date" content="{{ page.publication-date }}" />
<meta name="DC.rights" content="{{ page.rights }}" />
<meta name="DC.source" content="{{ site.title }}" />

<!-- Open Graph metadata -->

<!-- Open Graph metadata -->
{% if page.layout == "default" %}
<meta property="og:title" content="{{page.title}}"/>
<meta property="og:title" content="{{page.title}}" />
<meta property="og:description" content="{{site.description}}">
<meta property="fb:admins" content="elotroalex"/>
<meta property="fb:admins" content="elotroalex" />
<meta property="og:type" content="website" />
<meta property="og:url" content="{{site.url}}{{site.baseurl}}{{page.url}}"/>
<meta property="fb:app_id" content="589495744558280"/>
<meta property="og:image" content="{{site.url}}{{site.baseurl}}/assets/open-graph-logo.png"/>
<meta property="og:url" content="{{site.url}}{{site.baseurl}}{{page.url}}" />
<meta property="fb:app_id" content="589495744558280" />
<meta property="og:image" content="{{site.url}}{{site.baseurl}}/assets/open-graph-logo.png" />
<meta property="og:image:width" content="200" />
<meta property="og:image:height" content="200" />

{% else %}
<meta property="og:title" content="{{page.title}}"/>
<meta property="og:title" content="{{page.title}}" />
<meta property="og:description" content="An Ed edition">
<meta property="fb:admins" content="elotroalex"/>
<meta property="fb:admins" content="elotroalex" />
<meta property="og:type" content="article" />
<meta property="og:url" content="{{site.url}}{{site.baseurl}}{{page.url}}"/>
<meta property="fb:app_id" content="589495744558280"/>
<meta property="og:image" content="{{site.url}}{{site.baseurl}}/assets/open-graph-logo.png"/>
<meta property="og:url" content="{{site.url}}{{site.baseurl}}{{page.url}}" />
<meta property="fb:app_id" content="589495744558280" />
<meta property="og:image" content="{{site.url}}{{site.baseurl}}/assets/open-graph-logo.png" />
<meta property="og:image:width" content="200" />
<meta property="og:image:height" content="200" />
{% endif %}

<title>
{% if page.title == "Home" %}
{{ site.title }}
Expand All @@ -51,13 +50,12 @@
</title>

<!-- CSS link -->
<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/style.css"/>

<link rel="stylesheet" href="{{ site.baseurl }}/assets/css/style.css" />

<!-- Icons -->
<link rel="apple-touch-icon-precomposed" sizes="180x180" href="{{ site.baseurl }}/assets/apple-touch-icon-precomposed.png"/>
<link rel="shortcut icon" href="{{ site.baseurl }}/assets/favicon.ico"/>
<link rel="apple-touch-icon-precomposed" sizes="180x180" href="{{ site.baseurl }}/assets/apple-touch-icon-precomposed.png" />
<link rel="shortcut icon" href="{{ site.baseurl }}/assets/favicon.ico" />

<!-- RSS -->
<link rel="alternate" type="application/rss+xml" title="RSS" href="{{ site.baseurl }}/atom.xml"/>
<link rel="alternate" type="application/rss+xml" title="RSS" href="{{ site.baseurl }}/atom.xml" />
</head>
9 changes: 5 additions & 4 deletions _includes/sidebar-toc.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Target for toggling the sidebar `.sidebar-checkbox` is for regular
styles, `#sidebar-checkbox` for behavior. -->
<!--
Target for toggling the sidebar `.sidebar-checkbox` is for regular styles, `#sidebar-checkbox` for
behavior.
-->
<input type="checkbox" class="sidebar-checkbox" id="sidebar-checkbox">

<!-- Toggleable sidebar -->
Expand All @@ -10,11 +12,10 @@

<nav class="sidebar-nav">
<a class="sidebar-nav-item{% if page.url == site.baseurl %} active{% endif %}" href="{{ site.baseurl }}/">Home</a>
<a class="sidebar-nav-item{% if page.url == node.url %} active{% endif %}" href="#" data-proofer-ignore>Return to Top</a>
<a class="sidebar-nav-item{% if page.url == node.url %} active{% endif %}" href="#" data-proofer-ignore>Return to Top</a>
{% for node in page.toc %}
<a class="sidebar-nav-item{% if page.url == node.url %} active{% endif %} sidebar-nav-item-toc" href="#{{ node | slugify }}">{{ node }}</a>
{% endfor %}

</nav>

<div class="sidebar-item">
Expand Down
14 changes: 8 additions & 6 deletions _includes/sidebar.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Target for toggling the sidebar `.sidebar-checkbox` is for regular
styles, `#sidebar-checkbox` for behavior. -->
<!--
Target for toggling the sidebar `.sidebar-checkbox` is for regular styles, `#sidebar-checkbox` for
behavior.
-->
<input type="checkbox" class="sidebar-checkbox" id="sidebar-checkbox">

<!-- Toggleable sidebar -->
Expand All @@ -26,14 +28,14 @@
{% endfor %}

<!-- The code below is used for manually entered links -->

<span style='cursor:pointer;' onclick="javascript:var hypothesis = document.createElement('script');
hypothesis.setAttribute('src','https://hypothes.is/embed.js');
document.head.appendChild(hypothesis);"><a class="sidebar-nav-item">Annotate me</a></span>

<!-- <a class="sidebar-nav-item" href="https://via.hypothes.is/{{ site.url }}{{ site.baseurl }}{{page.url}}/" data-proofer-ignore>Annotate me</a> -->
<!-- -->
<!-- <script src="https://hypothes.is/embed.js" async></script> -->
<!--
<a class="sidebar-nav-item" href="https://via.hypothes.is/{{ site.url }}{{ site.baseurl }}{{page.url}}/" data-proofer-ignore>Annotate me</a>
<script src="https://hypothes.is/embed.js" async></script>
-->

<a class="sidebar-nav-item" href="https://github.com/minicomp/ed" target="_blank">GitHub project</a>
</nav>
Expand Down
12 changes: 7 additions & 5 deletions _layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
{% include sidebar.html %}
{% endif %}



<!-- Wrap is the content to shift when toggling the sidebar. We wrap the content to avoid any CSS collisions with our real content. -->
<!--
Wrap is the content to shift when toggling the sidebar. We wrap the content to avoid any CSS
collisions with our real content.
-->
<div class="wrap">
<div class="masthead">
<div class="container">
Expand Down Expand Up @@ -48,7 +49,7 @@ <h3 class="masthead-title">
document.getElementById("main").innerHTML = content.replace(regex, "<mark>$1</mark>");
}

// Toggle sidebar
// Toggle sidebar
(function(document) {
var toggle = document.querySelector('.sidebar-toggle');
var sidebar = document.querySelector('#sidebar');
Expand All @@ -65,7 +66,8 @@ <h3 class="masthead-title">
}, false);
})(document);
</script>
<!-- Facebook SDK for JavaScript -->

<!-- Facebook SDK for JavaScript -->
<script>
window.fbAsyncInit = function() {
FB.init({
Expand Down
2 changes: 1 addition & 1 deletion _layouts/drama.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
<div class="drama">
<h1 class="text-title">{{ page.title }}</h1>
{{ content }}
</div>
</div>
2 changes: 1 addition & 1 deletion _layouts/narrative.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
<h1 class="text-title">{{ page.title }}</h1>
<p class="citation"> by {{ page.author }}</p>
{{ content }}
</div>
</div>
2 changes: 1 addition & 1 deletion _layouts/poem.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
<h1 class="text-title">{{ page.title }}</h1>
<p class="byline">{{ page.author }}</p>
{{ content }}
</div>
</div>
2 changes: 1 addition & 1 deletion _layouts/post.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
<div class="post">
<h1 class="text-title">{{ page.title }}</h1>
{{ content }}
</div>
</div>
Loading

0 comments on commit ca45b08

Please sign in to comment.