RubyGems - ed. - Versions diffs - 0.1.1 → 1.0.0 - Mend

ed. 0.1.1 → 1.0.0

Files changed (16) hide show

checksums.yaml +4 -4
data/Gemfile +3 -0
data/README.md +4 -4
data/_includes/sidebar.html +7 -2
data/_layouts/default.html +2 -2
data/_sass/_ed.scss +63 -88
data/_texts/narrative.md +1 -1
data/_texts/o-captain.md +0 -1
data/about.md +2 -2
data/assets/css/style.scss +31 -1
data/assets/screenshot-home.png +0 -0
data/documentation.md +43 -7
data/optional/balloon-css/_balloon.scss +312 -0
data/optional/jekyll-scholar starter kit/Rakefile +3 -1
data/optional/tei-to-ed/tei-to-ed.xsl +158 -0
metadata +12 -9

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78048831d357934b0a664c4f49e35008d9ce7c49
-  data.tar.gz: 987819bc6c83786bc9706f4d7deac28bdfff9064
+  metadata.gz: 759390e07ffd6398c7be74abb8c78156d0afc520
+  data.tar.gz: 147f635218412cdd6abc641efe2aecfdea56a9e2
 SHA512:
-  metadata.gz: ac8180456fa0316f4b37877602efa43ace80340261945bd0fecce51c64aa879ae64cf1df78a8fb7ef242f9a02534b3328f1bea6915146f683758ddc07c1825e2
-  data.tar.gz: a8fa3313e4da12ab36240df696807378d5f58af257d5610c2d66dfeada490fca0095bcdd47db34755ccef9b27b200c5f21588283ff3467c73e4f412384699abe
+  metadata.gz: 0a972b98a79634ea2939aea2705266aabc417e645e65e24e6c421d995be10a55fe309351c547fa0a21176c7f1b2c1962fa553296695bb0dd0e4694540dbef40a
+  data.tar.gz: 9429c09f1efbd542322d6b09577686e895f022c8c60891ea6a4a57e2a82945733a674ae3f7166c5ab251a852f50a2141e7eb4088ec3880ec9285b4b514db0cc4

data/Gemfile CHANGED

@@ -1,2 +1,5 @@
 source "https://rubygems.org"
 gemspec
+gem "html-proofer"
+gem 'coveralls', require: false

data/README.md CHANGED

@@ -1,9 +1,9 @@
 # Ed: A Jekyll Theme for Minimal Editions
-[![Build Status](https://travis-ci.org/elotroalex/ed.svg?branch=gh-pages)](https://travis-ci.org/elotroalex/ed)
+[![Build Status](https://travis-ci.org/elotroalex/ed.svg?branch=gh-pages)](https://travis-ci.org/elotroalex/ed) [![Gem Version](https://badge.fury.io/rb/ed..svg)](https://badge.fury.io/rb/ed.)
-![Sample Ed screenshot](https://github.com/elotroalex/ed/blob/master/assets/screenshot.png)
+![Sample Ed screenshot](https://github.com/elotroalex/ed/blob/master/assets/screenshot-home.png)
@@ -19,7 +19,7 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
 ## Sample Ed editions.
-- [Our sample site](http://elotroalex.github.io/ed/) is the first edition built with Ed.
+- [Our sample site](http://minicomp.github.io/ed/) is the first edition built with Ed.
 - [Fugitive Verses](http://fugitiverses.viraltexts.org/): Popular Reprinted Poetry from Nineteenth Century Newspapers
 - [mini lazarillo](http://minilazarillo.github.io/): A minimal edition of the *Lazarillo de Tormes*
 - [Making and Knowing](https://cu-mkp.github.io/GR8975-edition/): The BnF Ms Fr 640 in Translation
@@ -44,4 +44,4 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
 ## Installing and using Ed
-To learn how to install and begin using Ed, please visit our [documentation page](http://elotroalex.github.io/ed/documentation).
+To learn how to install and begin using Ed, please visit our [documentation page](http://minicomp.github.io/ed/documentation).

data/_includes/sidebar.html CHANGED

@@ -27,13 +27,18 @@
     <!-- 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>
+<!--     <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/elotroalex/ed" target="_blank">GitHub project</a>
   </nav>
   <div class="sidebar-item">
-    <p>Currently v0.1.0. Distributed with an MIT license.</p>
+    <p>Currently v1.0 Distributed with an MIT license.</p>
   </div>
 </div>

data/_layouts/default.html CHANGED

@@ -3,7 +3,7 @@
   {% include head.html %}
-  <body>
+  <body class="theme-base-{{site.color-scheme}}">
     <!-- This if statement decides which sidebar to use -->
     {% if page.toc %}
@@ -19,7 +19,7 @@
       <div class="masthead">
         <div class="container">
           <h3 class="masthead-title">
-            <a href="{{ site.baseurl }}/" title="Home">{{ site.title }}</a>
+            <a href="{{ site.baseurl }}/" title="Home">{{ site.title | newline_to_br }}</a>
             <br><small>{{ site.tagline }}</small>
           </h3>
         </div>

data/_sass/_ed.scss CHANGED

@@ -11,22 +11,7 @@
  */
- /*
- * Common Variables
- *
- * Feel free to change!
- *
- */
-$main-font: "Palatino Linotype", "Book Antiqua", Palatino, serif;
-$heading-font: sans-serif;
-$heading-color: #404040;
-$text-color: #454545;
-$regular-font-size: 20px;
-$link-color: #841212;
 /* To apply a different color scheme to the whole scroll down to the themes section for instructions */
@@ -544,128 +529,116 @@ a.sidebar-nav-item:focus {
 }
+/*
+ * Overlay sidebar
+ *
+ * Make the sidebar content overlay the viewport content instead of pushing it
+ * aside when toggled.
+ */
+.sidebar-overlay #sidebar-checkbox:checked ~ .wrap {
+  -webkit-transform: translateX(0);
+      -ms-transform: translateX(0);
+          transform: translateX(0);
+}
+.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar-toggle {
+  box-shadow: 0 0 0 .25rem #fff;
+}
+.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
+  box-shadow: .25rem 0 .5rem rgba(0,0,0,.1);
+}
+/* Only one tweak for a reverse layout */
+.layout-reverse.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
+  box-shadow: -.25rem 0 .5rem rgba(0,0,0,.1);
+}
 /*
  * Themes
  *
- * Apply custom color schemes by adding the appropriate class to the `body`.
- * Based on colors from Base16: http://chriskempson.github.io/base16/#default.
+ * Applies custom color schemes by adding the appropriate class to the `body`. Based on colors from Base16: http://chriskempson.github.io/base16/#default.
  */
 /* Red */
-.theme-base-08 .sidebar,
-.theme-base-08 .sidebar-toggle:active,
-.theme-base-08 #sidebar-checkbox:checked ~ .sidebar-toggle {
+.theme-base-red .sidebar,
+.theme-base-red .sidebar-toggle:active,
+.theme-base-red #sidebar-checkbox:checked ~ .sidebar-toggle {
   background-color: #ac4142;
 }
-.theme-base-08 .container a,
-.theme-base-08 .sidebar-toggle,
-.theme-base-08 .related-posts li a:hover {
+.theme-base-red .container a,
+.theme-base-red .sidebar-toggle,
+.theme-base-red .related-posts li a:hover {
   color: #ac4142;
 }
 /* Orange */
-.theme-base-09 .sidebar,
-.theme-base-09 .sidebar-toggle:active {
+.theme-base-orange .sidebar,
+.theme-base-orange .sidebar-toggle:active {
   background-color: #d28445;
 }
-.theme-base-09 .container a,
-.theme-base-09 .sidebar-toggle,
-.theme-base-09 .related-posts li a:hover {
+.theme-base-orange .container a,
+.theme-base-orange .sidebar-toggle,
+.theme-base-orange .related-posts li a:hover {
   color: #d28445;
 }
-/* Yellow */
-.theme-base-0a .sidebar,
-.theme-base-0a .sidebar-toggle:active {
-  background-color: #f4bf75;
-}
-.theme-base-0a .container a,
-.theme-base-0a .sidebar-toggle,
-.theme-base-0a .related-posts li a:hover {
-  color: #f4bf75;
-}
 /* Green */
-.theme-base-0b .sidebar,
-.theme-base-0b .sidebar-toggle:active {
+.theme-base-green .sidebar,
+.theme-base-green .sidebar-toggle:active {
   background-color: #90a959;
 }
-.theme-base-0b .container a,
-.theme-base-0b .sidebar-toggle,
-.theme-base-0b .related-posts li a:hover {
+.theme-base-green .container a,
+.theme-base-green .sidebar-toggle,
+.theme-base-green .related-posts li a:hover {
   color: #90a959;
 }
 /* Cyan */
-.theme-base-0c .sidebar,
-.theme-base-0c .sidebar-toggle:active {
+.theme-base-cyan .sidebar,
+.theme-base-cyan .sidebar-toggle:active {
   background-color: #75b5aa;
 }
-.theme-base-0c .container a,
-.theme-base-0c .sidebar-toggle,
-.theme-base-0c .related-posts li a:hover {
+.theme-base-cyan .container a,
+.theme-base-cyan .sidebar-toggle,
+.theme-base-cyan .related-posts li a:hover {
   color: #75b5aa;
 }
 /* Blue */
-.theme-base-0d .sidebar,
-.theme-base-0d .sidebar-toggle:active {
+.theme-base-blue .sidebar,
+.theme-base-blue .sidebar-toggle:active {
   background-color: #6a9fb5;
 }
-.theme-base-0d .container a,
-.theme-base-0d .sidebar-toggle,
-.theme-base-0d .related-posts li a:hover {
+.theme-base-blue .container a,
+.theme-base-blue .sidebar-toggle,
+.theme-base-blue .related-posts li a:hover {
   color: #6a9fb5;
 }
 /* Magenta */
-.theme-base-0e .sidebar,
-.theme-base-0e .sidebar-toggle:active {
+.theme-base-magenta .sidebar,
+.theme-base-magenta .sidebar-toggle:active {
   background-color: #aa759f;
 }
-.theme-base-0e .container a,
-.theme-base-0e .sidebar-toggle,
-.theme-base-0e .related-posts li a:hover {
+.theme-base-magenta .container a,
+.theme-base-magenta .sidebar-toggle,
+.theme-base-magenta .related-posts li a:hover {
   color: #aa759f;
 }
 /* Brown */
-.theme-base-0f .sidebar,
-.theme-base-0f .sidebar-toggle:active {
+.theme-base-brown .sidebar,
+.theme-base-brown .sidebar-toggle:active {
   background-color: #8f5536;
 }
-.theme-base-0f .container a,
-.theme-base-0f .sidebar-toggle,
-.theme-base-0f .related-posts li a:hover {
+.theme-base-brown .container a,
+.theme-base-brown .sidebar-toggle,
+.theme-base-brown .related-posts li a:hover {
   color: #8f5536;
 }
-/*
- * Overlay sidebar
- *
- * Make the sidebar content overlay the viewport content instead of pushing it
- * aside when toggled.
- */
-.sidebar-overlay #sidebar-checkbox:checked ~ .wrap {
-  -webkit-transform: translateX(0);
-      -ms-transform: translateX(0);
-          transform: translateX(0);
-}
-.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar-toggle {
-  box-shadow: 0 0 0 .25rem #fff;
-}
-.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
-  box-shadow: .25rem 0 .5rem rgba(0,0,0,.1);
-}
-/* Only one tweak for a reverse layout */
-.layout-reverse.sidebar-overlay #sidebar-checkbox:checked ~ .sidebar {
-  box-shadow: -.25rem 0 .5rem rgba(0,0,0,.1);
-}
 /*                    */
 /* ED SPECIAL LAYOUTS */
 /*                    */
@@ -869,3 +842,5 @@ li.prose-indent {
   text-indent: 2rem;
 }

data/_texts/narrative.md CHANGED

@@ -29,7 +29,7 @@ toc:
 ## Editor's note
-This version of *Narrative of the Life of Frederick Douglass* was adapted from *The Project Gutenberg EBook of The Narrative of the Life of Frederick Douglass, by Frederick Douglass*. The [Guttenberg file](https://www.gutenberg.org/files/23/23-h/23-h.htm) does not tell us which witness was used in making their digital edition. The edition below is only a slightly modified version of the Guttenberg text, and therefore should not be taken too seriously as an edition. I use the text mostly to show a few affordances of using Ed for long form narrative. This page, for example, showcases a different sidebar than the rest of our sample site, with a table of content of the novel generated out of metadata in the source file. In addition, reading morsels of the novel on your different devices can give you a sense of the experience of reading prose using Ed, and shows you an example of the optional sidebar with a table of contents. A few other features of this page are described in more detail in the [Documentation]({{ site.baseurl }}/documentation/).
+This version of *Narrative of the Life of Frederick Douglass* was adapted from *The Project Gutenberg EBook of The Narrative of the Life of Frederick Douglass, by Frederick Douglass*. The [Guttenberg file](http://www.gutenberg.org/) does not tell us which witness was used in making their digital edition. The edition below is only a slightly modified version of the Guttenberg text, and therefore should not be taken too seriously as an edition. I use the text mostly to show a few affordances of using Ed for long form narrative. This page, for example, showcases a different sidebar than the rest of our sample site, with a table of content of the novel generated out of metadata in the source file. In addition, reading morsels of the novel on your different devices can give you a sense of the experience of reading prose using Ed, and shows you an example of the optional sidebar with a table of contents. A few other features of this page are described in more detail in the [Documentation]({{ site.baseurl }}/documentation/).
 ---

data/_texts/o-captain.md CHANGED

@@ -15,7 +15,6 @@ source: Poetry Foundation
 - {:.indent-5}Where on the deck my Captain lies,
 - {:.indent-6}Fallen cold and dead.
 - O Captain! my Captain! rise up and hear the bells;
 - Rise up—for you the flag is flung—for you the bugle[^fn2] trills,
 - For you bouquets and ribbon’d wreaths—for you the shores a-crowding,

data/about.md CHANGED

@@ -10,7 +10,7 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
 ## Sample Ed editions.
-- [Our sample site](http://elotroalex.github.io/ed/) is the first edition built with Ed.
+- [Our sample site](http://minicomp.github.io/ed/) is the first edition built with Ed.
 - [Fugitive Verses](http://fugitiverses.viraltexts.org/): Popular Reprinted Poetry from Nineteenth Century Newspapers
 - [mini lazarillo](http://minilazarillo.github.io/): A minimal edition of the *Lazarillo de Tormes*
 - [Making and Knowing](https://cu-mkp.github.io/GR8975-edition/): The BnF Ms Fr 640 in Translation
@@ -35,4 +35,4 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
 ## Installing and using Ed
-To learn how to install and begin using Ed, please visit our [documentation page](http://elotroalex.github.io/ed/documentation/).
+To learn how to install and begin using Ed, please visit our [documentation page](http://minicomp.github.io/ed/documentation/).

data/assets/css/style.scss CHANGED

@@ -2,5 +2,35 @@
 sitemap: false
 ---
+/*
+* Common Variables
+*
+* Feel free to change!
+*
+*/
+/* FONTS */
+$main-font: "Palatino Linotype", "Book Antiqua", Palatino, serif;
+$heading-font: sans-serif;
+$regular-font-size: 20px;
+/*
+* COLOR.
+*
+* Make sure to leave color-scheme in config file empty for granular control
+*
+*/
+$text-color: #454545;
+$heading-color: #404040;
+$link-color: #841212;
 @import "ed";
-@import "syntax";
+@import "syntax";

data/assets/screenshot-home.png ADDED

Binary file

data/documentation.md CHANGED

@@ -123,9 +123,37 @@ Copy the url from your terminal log and paste it into your browser of choice (I
 ---
+## Installing Ed: Replacing an existing Jekyll theme
+Ed, like Jekyll, is also a gem. Jekyll gives you the option to switch themes, as long as those themes are gems as well. If you have existing content and would like to use Ed, you need to add the following line to your _config.yml file, usually at the bottom:
+~~~
+theme: "ed."
+~~~
+You also need to add the gem to your Gemfile file:
+~~~
+gem "ed.", "0.1.1"
+~~~
+Make sure to replace the version number with the one you need. I will do my best to document what changes come with each new gem. If your current theme does not have a Gemfile, you would need to create one and add the line above. The Gemfile is a plain text file like all other files in Jekyll, and should not have a file extension.
+After these files have been modified, you need to update your Bundle in the terminal:
+~~~ bash
+$ bundle update
+~~~
+When using the gem on top of a previous theme, you will not have all the files of a full Ed install immediately available to you. More importantly, you may not have a _texts folder. You need to create one or copy them from a full installation of Ed. You might also want to add the search and index file. The gem comes bundled with all these files once you install it on your system, but they won't be in the same folder as your project. To locate them you can refer to the [Jekyll documentation for gem-based themes](https://jekyllrb.com/docs/themes/). With some previous themes you might need to erase lingering files that interfere with the functioning of Ed. This can be an advanced operation I can't do justice to here. At that point you might need to familiarize yourself with the architecture of Jekyll, or pay close attention to errors when you try to serve the site, and reverse-engineer from there.
+Going forward, updating to a new version of Ed is as simple as changing the release version and running the bundle update. I will try to keep changes in the actual markup to a minimum, but will let users know if any changes require a global find and replace in your editions.
+---
 ## Jekyll
-Ed is a Jekyll theme. That means you will need some familiarity with Jekyll to take advantage of its full potential. While running a Jekyll site is a bit more involved than Wordpress and other similar tools, the payoff in the long term is worth the effort to learn it. If you are new to Jekyll, I recommend you take a look at ["How (and Why) to Generate a Static Website Using Jekyll"](http://chronicle.com/blogs/profhacker/jekyll1/60913) at ProfHacker, and the excellent [Jekyll documentation](http://jekyllrb.com/) to start getting a sense of how it works.
+Ed is a Jekyll theme. That means you will need some familiarity with Jekyll to take advantage of its full potential. While running a Jekyll site is a bit more involved than Wordpress and other similar tools, the payoff in the long term is worth the effort to learn it. If you are new to Jekyll, I recommend you take a look at ["How (and Why) to Generate a Static Website Using Jekyll"](http://chronicle.com/blogs/profhacker/jekyll1/60913) at ProfHacker, Amanda Visconti's excellent [Building a static website with Jekyll and GitHub Pages](http://programminghistorian.org/lessons/building-static-sites-with-jekyll-github-pages) on *The Programming Historian* and [Jekyll's own documentation](http://jekyllrb.com/) to start getting a sense of how it works.
 Once you have gone through these tutorials, you can get started using Ed by replacing the sample texts included in in the `_texts` folder in Ed with your own edited texts. Remember to always and only edit files in Ed using [a plain text editor](https://en.wikipedia.org/wiki/Text_editor), and *not* a word processor. I'm composing this file using a plain text editor called [Sublime Text](http://www.sublimetext.com/).
@@ -177,7 +205,7 @@ To indent specific lines we take advantage of a feature in kramdown that allows
 - {:.indent-6} Fallen cold and dead.
 ~~~
-The `-` at the beginning of each line indicates that these are lines. The `{:.indent-3}` is what we need to in order to indicate the indent value for that line. Values can range from 1-10. You can expand the range or adjust the values in the CSS stylesheet in the `public` folder.
+The `-` at the beginning of each line indicates that these are lines. The `{:.indent-3}` is what we need to in order to indicate the indent value for that line. Values can range from 1-10. You can expand the range or adjust the values in the Ed stylesheet (`_ed.scss`) in the `_sass` folder.
 The example from Raisin in the Sun shows us that we don't need much special markup for theater as long as we use CAPITAL LETTERS for speakers. Italics for directions are easy enough. Just use `*` around the words you want to italicize.
@@ -264,7 +292,7 @@ Your editions are treated as [collections](https://jekyllrb.com/docs/collections
 You will notice that the homepage in particular has a `.html` file ending instead of a `.md` ending. All template files in Jekyll are HTML, and the index behaves as a template file. Although these files are mostly written in HTML, notice that they still contain YAML front matter and liquid tags. To edit the homepage replace the content on the file shipped with Ed, making sure that your changes to `index.html` are written in valid HTML. The same goes for the template files in the `_layouts` folder.
-Ed also comes with a search page, `search.html`. This page implements [elastic lunr](http://elasticlunr.com/), "a lightweight full-text search engine in Javascript for browser search and offline search." This simple search page can be useful if you have large collections of texts. If you don't, and don't feel the need, go ahead and delete it along with the `public/js` folder.
+Ed also comes with a search page, `search.html`. This page implements [elastic lunr](http://elasticlunr.com/), "a lightweight full-text search engine in Javascript for browser search and offline search." This simple search page can be useful if you have large collections of texts. If you don't, and don't feel the need, go ahead and delete it along with the `assets/js` folder.
 Besides the homepage and the search page, Ed ships with an About page, `about.md` and a documentation page, `documentation.md`, i.e. this page. As you can see, these are regular `.md` files. You can replace the contents of each file using normal kramdown syntax. This also applies to any new page you create, which you should remember to save with an `.md` extension. When editing the `bibliography.md` file, be careful not to replace the liquid tag that generates your bibliography, unless you don't want to have a bibliography at all.
@@ -367,7 +395,11 @@ Note that our jekyll-scholar starter kit comes ready for MLA style. To use Chica
 **Publishing your site on Github Pages with jekyll-scholar**
-If you install jekyll-scholar, or most other plugins in Jekyll, you will need a workaround to publish your site on Github Pages, which only runs in 'safe mode.' I've provided a slightly modified version of a `Rakefile` originally created by [Robert Rawlins](https://blog.sorryapp.com/blogging-with-jekyll/2014/01/31/using-jekyll-plugins-on-github-pages.html) that will help you accomplish this task. Once you are ready to publish, switch to your `gh-pages` branch and run the following command `rake ed:publish`.
+If you install jekyll-scholar, or most other plugins in Jekyll, you will need a workaround to publish your site on Github Pages, which only runs in 'safe mode.' I've provided a slightly modified version of a `Rakefile` originally created by [Robert Rawlins](https://blog.sorryapp.com/blogging-with-jekyll/2014/01/31/using-jekyll-plugins-on-github-pages.html) that will help you accomplish this task. Once you are ready to publish, switch to your `gh-pages` branch and run the following command:
+~~~ bash
+$ rake ed:publish
+~~~
 ---
@@ -378,10 +410,12 @@ If you install jekyll-scholar, or most other plugins in Jekyll, you will need a
 - Make sure to add horizontal rules, `---`, to separate sections in your texts. This creates a more pleasant layout.
 - You can clean unnecessary folders and files from the original Ed package before publishing your site. This will help you reduce overhead. For example, you can erase this page, the sample texts and the `syntax.css` file (used for styling code).
 - Consider providing tips for your readers on how to make their font bigger or smaller by taking advantage of <kbd>Command</kbd> + <kbd>+</kbd> and <kbd>Command</kbd> + <kbd>-</kbd>. Or returning to the top of the page using <kbd>Command</kbd> + <kbd>Up Arrow</kbd>. Part of the philosophy behind Ed is to avoid duplicating features that are already easily available in most web ecosystems.
-- If you want to allow annotations on your site, consider providing a `via.hypothes.is` link. Our sample site can be annotated, for example, using the following link: `https://via.hypothes.is/http://elotroalex.github.io/ed/`, which readers can access on the sidebar. Once you've indicated your own URL in the config file, the link will update automatically. Make sure to visit [hypothes.is](https://hypothes.is/) to learn more.
+- If you want to allow annotations on your site, consider providing a `via.hypothes.is` link. Our sample site can be annotated, for example, using the following link: `https://via.hypothes.is/http://minicomp.github.io/ed/`, which readers can access on the sidebar. Once you've indicated your own URL in the config file, the link will update automatically. Make sure to visit [hypothes.is](https://hypothes.is/) to learn more.
 - Ed includes metadata in the headers that makes it easier for users of Zotero, and other systems to grab bibliographic information for the site and individual texts. Our metadata functionality may not be enough to generate a full proper citation. Consider providing visible citation information in your about page or homepage.
 - Make sure to deepen your knowledge of the building blocks of Ed: Jekyll, YAML and Liquid. A great list of resources can be found in the blog "[Jekyll for Web Designers](http://jameswillweb.github.io/jekyll-for-designers/resources.html)".
 - Our base themes Poole/Lanyon allow for easily customization of the interface. You can, for example, switch the position of the sidebar, change the theme colors and overlay options. To learn more check out the [Lanyon documentation](https://github.com/poole/lanyon#themes), and make sure to try the green, `.theme-base-0b`, it's really nice.
+- You can change the look and feel of the site as a whole by changing the `color-scheme` in the `_config.yml` file. If you want to have more granularity, short of editing the `css`, you can change the variable values in the `assets/css/style.scss` file.
+- In the `optional` folder you will find a sample `xslt` to help you get started converting TEI to Ed. You will also find css for adding pop-up "balloons" or tooltips to your texts.
 ---
@@ -414,7 +448,9 @@ If you do decide to use the GitHub pages option, please make sure to read the [n
 To publish on GitHub pages, you must have a copy of the repository in GitHub. That means you also need an account there. Once you've created the repository that you will use, you must link your local repository to the one on GitHub. Notice that because you cloned the original source files from my repository, it will be linked to my repository (to which you don't have writing privileges) until you do this step. Instructions for changing the remote URL can be found [here](https://help.github.com/articles/changing-a-remote-s-url/).
-You also need to create a different git branch called `gh-pages` within your local repository for your site. This is the branch that will get published by GitHub. To create and use that branch use the following command:
+The usual way of doing it is to create a different git branch called `gh-pages` within your local repository for your site. This is a branch is published by GitHub by default. GitHub also gives you the option to select [any branch you want to publish](https://github.com/blog/2228-simpler-github-pages-publishing), including the master branch.
+In the following I use the gh-pages branch. To create and use that branch use the following command:
 ~~~ bash
 $ git checkout -b gh-pages
@@ -426,7 +462,7 @@ Once you are using that branch, you are ready to publish your site. To do so use
 $ git push origin gh-pages
 ~~~
-You can now access your site using an address that looks like `http://your-username.github.io/your-project-name`. The sample page for Ed, for example, is hosted at [elotroalex.github.io/ed](http://elotroalex.github.io/ed).
+You can now access your site using an address that looks like `http://your-username.github.io/your-project-name`. The sample page for Ed, for example, is hosted at [minicomp.github.io/ed](http://minicomp.github.io/ed).
 **<span id="a-note-on-your-base-url">A note on your base url</span>**

data/optional/balloon-css/_balloon.scss ADDED

@@ -0,0 +1,312 @@
+//******
+// SEE https://github.com/kazzkiq/balloon.css
+// ******
+//
+// Variables
+// -----------------------------------------
+$balloon-bg:             fade-out(#111, .1);
+$balloon-base-size:      12px;
+$balloon-arrow-height:   6px;
+$breakpoint:             860px; //When to not show annotations
+//
+// Mixins
+// -----------------------------------------
+@mixin svg-arrow ($color, $position: up) {
+    $degrees: 0;
+    $height:  6px;
+    $width:   18px;
+    @if ($position == down) {
+        $degrees: 180 18 6;
+    } @else if ($position == left) {
+        $degrees: -90 18 18;
+        $width: 6px;
+        $height: 18px;
+    } @else if ($position == right) {
+        $degrees: 90 6 6;
+        $width: 6px;
+        $height: 18px;
+    }
+    background: no-repeat url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="#{$width * 2}" height="#{$height * 2}"><path fill="#{$color}" transform="rotate(#{$degrees})" d="M2.658,0.000 C-13.615,0.000 50.938,0.000 34.662,0.000 C28.662,0.000 23.035,12.002 18.660,12.002 C14.285,12.002 8.594,0.000 2.658,0.000 Z"/></svg>');
+    background-size: 100% auto;
+    width: $width;
+    height: $height;
+}
+@mixin transition ($args...) {
+  -webkit-transition: $args;
+  -moz-transition: $args;
+  -ms-transition: $args;
+  -o-transition: $args;
+  transition: $args;
+}
+@mixin transform ($val) {
+  -webkit-transform: $val;
+  -moz-transform: $val;
+  -ms-transform: $val;
+  transform: $val;
+}
+@mixin transform-origin ($val) {
+  -webkit-transform-origin: $val;
+  -moz-transform-origin: $val;
+  -ms-transform-origin: $val;
+  transform-origin: $val;
+}
+@mixin opacity ($trans) {
+  filter: alpha(opactiy=($trans * 100));
+  -ms-filter: "progid:DXImageTransform.Microsoft.Alpha(Opacity=#{$trans * 100})";
+  -moz-opacity: $trans;
+  -khtml-opacity: $trans;
+  opacity: $trans;
+}
+@mixin base-effects () {
+    @include opacity(0);
+    pointer-events: none;
+    @include transition(all .18s ease-out .18s);
+}
+//
+// Styles
+// -----------------------------------------
+@media screen and (min-width: $breakpoint) {
+  [data-balloon] {
+      position: relative; // alt. absolute or fixed
+      &:after {
+          @include base-effects();
+          background: $balloon-bg;
+          border-radius: 4px;
+          color: #fff;
+          content: attr(data-balloon);
+          font-family: Helvetcia, sans-serif;
+          text-align: left;
+          font-size: $balloon-base-size + 2;
+          padding: .5em 1em;
+          position: absolute;
+          white-space: nowrap;
+          z-index: 10;
+      }
+      &:before {
+          @include svg-arrow($balloon-bg);
+          @include base-effects();
+          content: '';
+          position: absolute;
+          z-index: 10;
+      }
+      &:hover {
+          &:before,
+          &:after {
+              @include opacity(1);
+              pointer-events: auto;
+          }
+      }
+      &[data-balloon-break] {
+          &:after {
+              white-space: normal;
+          }
+      }
+      &[data-balloon-pos="up"] {
+          &:after {
+              bottom: 100%;
+              left: 50%;
+              margin-bottom: 5px + $balloon-arrow-height;
+              @include transform(translate(-50%, 10px));
+              @include transform-origin(top);
+          }
+          &:before {
+              bottom: 100%;
+              left: 50%;
+              margin-bottom: 5px;
+              @include transform(translate(-50%, 10px));
+              @include transform-origin(top);
+          }
+          &:hover {
+              &:after {
+                  @include transform(translate(-50%, 0));
+              }
+              &:before {
+                @include transform(translate(-50%, 0));
+              }
+          }
+      }
+      &[data-balloon-pos='down'] {
+          &:after {
+              left: 50%;
+              margin-top: 5px + $balloon-arrow-height;
+              top: 100%;
+              @include transform(translate(-50%, -10px));
+          }
+          &:before {
+              @include svg-arrow($balloon-bg, 'down');
+              left: 50%;
+              margin-top: 5px;
+              top: 100%;
+              @include transform(translate(-50%, -10px));
+          }
+          &:hover {
+              &:after {
+                  @include transform(translate(-50%, 0));
+              }
+              &:before {
+                  @include transform(translate(-50%, 0));
+              }
+          }
+      }
+      &[data-balloon-pos='left'] {
+          &:after {
+              margin-right: 5px + $balloon-arrow-height;
+              right: 100%;
+              top: 50%;
+              @include transform(translate(10px, -50%));
+          }
+          &:before {
+              @include svg-arrow($balloon-bg, 'left');
+              margin-right: 5px;
+              right: 100%;
+              top: 50%;
+              @include transform(translate(10px, -50%));
+          }
+          &:hover {
+              &:after {
+                  @include transform(translate(0, -50%));
+              }
+              &:before {
+                  @include transform(translate(0, -50%));
+              }
+          }
+      }
+      &[data-balloon-pos='right'] {
+          &:after {
+              left: 100%;
+              margin-left: 5px + $balloon-arrow-height;
+              top: 50%;
+              @include transform(translate(-10px, -50%));
+          }
+          &:before {
+              @include svg-arrow($balloon-bg, 'right');
+              left: 100%;
+              margin-left: 5px;
+              top: 50%;
+              @include transform(translate(-10px, -50%));
+          }
+          &:hover {
+              &:after {
+                  @include transform(translate(0, -50%));
+              }
+              &:before {
+                  @include transform(translate(0, -50%));
+              }
+          }
+      }
+      &[data-balloon-length='small'] {
+          &:after {
+              white-space: normal;
+              width: 80px;
+          }
+      }
+      &[data-balloon-length='medium'] {
+          &:before {
+              white-space: normal;
+              width: 150px;
+          }
+      }
+      &[data-balloon-length='large'] {
+          &:after {
+              white-space: normal;
+              width: 260px;
+          }
+      }
+      &[data-balloon-length='xlarge'] {
+          &:after {
+              white-space: normal;
+              width: 380px;
+              @media screen and (max-width: 768px) {
+                  white-space: normal;
+                  width: 90vw;
+              }
+          }
+      }
+      &[data-balloon-length='fit'] {
+          &:after {
+              white-space: normal;
+              width: 100%;
+          }
+      }
+  }
+}
+// Additional styles to make the buttons look like text
+button {
+  border: none;
+  background: none;
+  font-size: inherit;
+  font-family: inherit;
+  color: inherit;
+  margin: 0;
+  padding: 0;
+  border-bottom: 1px dotted $dark-grey;
+  cursor: help;
+}
+div#smallscreens {
+  display:none;
+}
+@media screen and (max-width: ($breakpoint - 1)) {
+  div#annotatededition {
+    display: none;
+  }
+  div#smallscreens {
+  display:inline;
+  }
+}

data/optional/jekyll-scholar starter kit/Rakefile CHANGED

@@ -19,8 +19,10 @@ namespace :ed do
   # We built this little rake task to help make that a little bit eaiser.
   #
-  # Usage:
+  # To publish your site:
   # bundle exec rake ed:publish
   desc "Publish ed to gh-pages"
   task :publish do
     # Compile the Jekyll site using the config.

data/optional/tei-to-ed/tei-to-ed.xsl ADDED

@@ -0,0 +1,158 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="2.0"
+    xmlns:tei="http://www.tei-c.org/ns/1.0" exclude-result-prefixes="#all">
+    <xsl:output encoding="UTF-8" method="text"></xsl:output>
+<!-- for replacements of fancy quotes in source -->
+    <xsl:param name="doubleQuotePat">’</xsl:param>
+    <xsl:param name="doubleQuoteRep">&apos;</xsl:param>
+    <xsl:param name="singleQuotePat">‘</xsl:param>
+    <xsl:param name="singleQuoteRep">&apos;</xsl:param>
+    <xsl:template match="/">
+        <xsl:apply-templates select="//tei:body/tei:div"/>
+    </xsl:template>
+    <!-- <xsl:strip-space elements="*"/>-->
+    <xsl:template match="tei:body/tei:div">
+        <xsl:variable name="sect_id" select="@xml:id"/>
+        <xsl:result-document method="text" encoding="utf-8"
+             href="_texts/{$sect_id}-annotated.md" omit-xml-declaration="yes">
+            <xsl:text>---&#x0A;layout: narrative&#x0A;</xsl:text>
+            <xsl:text>title: </xsl:text>
+            <xsl:value-of select="normalize-space(tei:head)"/>
+            <xsl:text>&#x0A;</xsl:text>
+            <xsl:text>author:</xsl:text>
+            <xsl:text>&#x0A;</xsl:text>
+            <xsl:text>mode: annotated</xsl:text>
+            <xsl:text>&#x0A;</xsl:text>
+            <xsl:value-of select="tei:teiHeader/fileDesc/titleStmt/author"/>
+            <xsl:text>editor: Minimal Edition Class&#x0A;</xsl:text>
+            <xsl:text>rights: Public Domain&#x0A;</xsl:text>
+            <xsl:text>---&#x0A;&#x0A;</xsl:text>
+            <xsl:apply-templates/>
+            <!-- inline nav -->
+            <xsl:text>&#x0A;&#x0A;</xsl:text>
+            <xsl:text>&lt;div class="inline-nav" markdown="1"&gt;&#x0A;</xsl:text>
+	    <!-- open the div -->
+            <xsl:if test="preceding-sibling::tei:div[1]">
+	   <!-- preceding chapter -->
+              <xsl:text>[</xsl:text>
+              <xsl:value-of select="preceding-sibling::tei:div[1]/tei:head"/>
+              <xsl:text>]</xsl:text>
+              <xsl:text>({{site.baseurl}}/texts/</xsl:text>
+              <xsl:value-of select="preceding-sibling::tei:div[1]/@xml:id"/>
+              <xsl:text>-annotated.html){:.previous}&#x0A;</xsl:text>
+            </xsl:if>
+            <xsl:if test="following-sibling::tei:div[1]">
+	   <!-- following chapter -->
+              <xsl:text>[</xsl:text>
+              <xsl:value-of select="following-sibling::tei:div[1]/tei:head"/>
+              <xsl:text>]</xsl:text>
+              <xsl:text>({{site.baseurl}}/texts/</xsl:text>
+              <xsl:value-of select="following-sibling::tei:div[1]/@xml:id"/>
+              <xsl:text>-annotated.html){:.following}&#x0A;</xsl:text>
+            </xsl:if>
+            <xsl:text>&#x0A;&lt;/div&gt;</xsl:text>
+	   <!-- close the div -->
+        </xsl:result-document>
+    </xsl:template>
+    <xsl:template match="tei:body/tei:div/tei:head">
+    </xsl:template>
+    <xsl:template match="tei:head">
+        <xsl:text>&#xa;</xsl:text>
+        <xsl:text>## </xsl:text>
+        <xsl:apply-templates></xsl:apply-templates>
+        <xsl:text>&#xa;&#xa;</xsl:text>
+    </xsl:template>
+    <xsl:template match="tei:p">
+        <xsl:text>&#x0A;</xsl:text>
+        <xsl:apply-templates/>
+        <xsl:text>&#x0A;</xsl:text>
+    </xsl:template>
+<!-- data balloons for links to notes -->
+    <xsl:template match="tei:ptr">
+      <xsl:text> &lt;button markdown="0" data-balloon-pos="up" data-balloon-length="large" data-balloon="</xsl:text>
+      <xsl:value-of  disable-output-escaping="yes" select="following::tei:note[@xml:id=translate(current()/@target, '#', '')]/replace(replace(replace(replace(., '-', '—'), '\s+', ' '), $doubleQuotePat, $doubleQuoteRep), $singleQuotePat, $singleQuoteRep)" />
+<!--
+     <xsl:message select="translate(current()/@target, '#', '')"></xsl:message>
+-->
+      <xsl:text>"&gt;</xsl:text>
+      <xsl:apply-templates />
+        <xsl:text>&lt;</xsl:text>span class="note_label"<xsl:text>&gt;</xsl:text><xsl:value-of select="@type"/><xsl:text>&lt;/span&gt;&#160;</xsl:text>
+      <xsl:text>&lt;/button&gt; </xsl:text>
+    </xsl:template>
+<!-- sanitize text nodes for kramdown -->
+    <xsl:template match="text()">
+        <xsl:value-of select="replace(replace(., '-', '—'), '\s+', ' ')"></xsl:value-of>
+    </xsl:template>
+<!-- link to page image -->
+    <xsl:template match="tei:pb">
+        <xsl:text>&lt;a href=""</xsl:text>
+        <xsl:value-of select="@facs"></xsl:value-of>
+        <xsl:text>"&gt;</xsl:text>
+        <xsl:text>&lt;img src="/assets/photo-icon.png" alt="Enlace al facsímil" style="display:inline-block; margin-bottom:-3px;"&gt;</xsl:text>
+        <xsl:text>&lt;/a&gt;</xsl:text>
+    </xsl:template>
+    <xsl:template match="tei:hi[@rend = 'italic']">
+        <span class="italic">
+        <xsl:apply-templates/>
+        </span>
+    </xsl:template>
+    <xsl:template match="tei:hi[@rend = 'bold']">
+        <span class="bold">
+        <xsl:apply-templates/>
+        </span>
+    </xsl:template>
+    <!-- data ballonons for tei:app -->
+    <xsl:template match="tei:app">
+        <xsl:text> &lt;button markdown="0" data-balloon-pos="up" data-balloon-length="large" data-balloon="in MS: </xsl:text>
+        <xsl:value-of  disable-output-escaping="yes" select="child::tei:rdg[1]/replace(replace(replace(replace(., '-', '—'), '\s+', ' '), $doubleQuotePat, $doubleQuoteRep), $singleQuotePat, $singleQuoteRep)" />
+        <xsl:message select="translate(current()/@target, '#', '')"></xsl:message>
+        <xsl:text>"&gt;</xsl:text>
+        <xsl:text>&lt;</xsl:text>span class="note_label"<xsl:text>&gt;</xsl:text><xsl:value-of select="@type"/><xsl:text>&lt;/span&gt;&#160;</xsl:text>
+        <xsl:text>&lt;/button&gt; </xsl:text>
+    </xsl:template>
+    <xsl:template match="tei:note" >
+        <xsl:call-template name="newline"/>
+        <xsl:text>&lt;</xsl:text>span class="note_label"<xsl:text>&gt;</xsl:text><xsl:value-of select="@xml:id"/><xsl:text>&lt;/span&gt;&#160;</xsl:text><xsl:apply-templates/>
+        <xsl:call-template name="newline"/>
+    </xsl:template>
+    <xsl:template name="newline">
+        <xsl:text>&#10;</xsl:text>
+    </xsl:template>
+</xsl:stylesheet>

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ed.
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Gil
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-07-06 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
 description:
 email:
 - colibri.alex@gmail.com
@@ -86,17 +86,20 @@ files:
 - assets/js/elasticlunr.min.js
 - assets/js/search.js
 - assets/open-graph-logo.png
+- assets/screenshot-home.png
 - atom.xml
 - credits.md
 - documentation.md
 - index.html
+- optional/balloon-css/_balloon.scss
 - optional/jekyll-scholar starter kit/Gemfile
 - optional/jekyll-scholar starter kit/Rakefile
 - optional/jekyll-scholar starter kit/_bibliography/references.bib
 - optional/jekyll-scholar starter kit/_config.yml
 - optional/jekyll-scholar starter kit/bibliography.md
+- optional/tei-to-ed/tei-to-ed.xsl
 - search.html
-homepage: http://elotroalex.github.io/ed/
+homepage: http://minicomp.github.io/ed/
 licenses:
 - MIT
 metadata: {}