Giter VIP home page Giter VIP logo

ed's Introduction

Ed: A Jekyll Theme for Minimal Editions

Build Status Gem Version

Sample Ed screenshot

Introduction

Ed is a Jekyll theme designed for textual editors based on minimal computing principles, and focused on legibility, durability, ease and flexibility.

One of our most pressing and ever-evolving 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 while flattening the learning curves for the user and the producer. Out of the box, the Ed 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 bandwidth. Our hope is that our approach can help beginners and veterans deploy beautiful editions with less effort, and that it can help us teach a 'full stack' in one academic semester, while allowing us to care for our projects at less cost, and perhaps, just perhaps, to generate high-quality editions on github.io in large quantities based on the git-lit model by Jonathan Reeve. We're coming for you, Kindle!

Sample Ed editions.

Current Features

  • Templates for narrative, drama and poetry
  • Responsive design for mobile phones, tablets and PCs.
  • Relatively easy to learn and teach
  • Works well in high- or low- bandwidth scenarios
  • Easier for digital archives and libraries to preserve
  • Open source, open access
  • Unobtrusive footnotes
  • Metadata in Dublin Core and OpenGraph to play nice with Zotero, libraries and social media.
  • Automatic table of content generation
  • Simple search functionality
  • Annotations via hypothes.is
  • Optional: Ability to generate well-formatted bibliographies and linked citations

Installing and using Ed

To learn how to install and begin using Ed, please visit our documentation page.

ed's People

Contributors

chrisfinazzo avatar elotroalex avatar johanngillium avatar karlstolley avatar ktbee avatar sagarjauhari avatar tcatapano avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ed's Issues

error running with jekyll-scholar enabled

Ive followed the instructions on enabling jekyll-scholar, but on running jekyll serve I get the following error:

CiteProc requires the `unicode_utils` or `unicode` Gem on Ruby 2.3
jekyll 3.0.5 | Error:  undefined method `upcase' for module `CiteProc'

This looks like this is an issue with jekyll-scholar (actually CiteProc), see: inukshuk/citeproc-ruby#60, but it's unclear how to fix. Any help is appreciated.

My environment:

OS Mac 10.12.6
Ruby 2.3.6
Jekyll 3.0.5
Ed ca45b08 (i.e., latest commit in master)

Title link shifted in Chrome

Hi!

When hovering the main title in Chrome, the link area, which turns the title to a link when hovered, seems to be shifted a few pixels above the text:
ed-1
ed-2

Curiously, I don't experience this behaviour in Firefox, and the masthead CSS seems fine to me.

Not supported warning

I am trying to use Jekyll in my repository. But everytime I push the site is not built/served correctly and receive this email:

The page build completed successfully, but returned the following warning for the gh-pages branch:
You are attempting to use a Jekyll theme, "ed.", which is not supported by GitHub Pages. Please visit https://pages.github.com/themes/ for a list of supported themes. If you are using the "theme" configuration variable for something other than a Jekyll theme, we recommend you rename this variable throughout your site. For more information, see https://help.github.com/articles/adding-a-jekyll-theme-to-your-github-pages-site/.

What is the issue?

Ruby Sass has reached end-of-life and should no longer be used.

I get the following message when I install this theme.

Post-install message from sass:

Ruby Sass has reached end-of-life and should no longer be used.

* If you use Sass as a command-line tool, we recommend using Dart Sass, the new
  primary implementation: https://sass-lang.com/install

* If you use Sass as a plug-in for a Ruby web framework, we recommend using the
  sassc gem: https://github.com/sass/sassc-ruby#readme

* For more details, please refer to the Sass blog:
  https://sass-lang.com/blog/posts/7828841

[WIP] Version 2.0 Feature List

@karlstolley,

Word on the street (@elotroalex ) has said that there's some kind of work afoot on updating ed., perhaps even with breaking, 2.0-level changes. I've talked to Alex a bit and looked over the state of the project as it is, and would like to suggest putting together a project here on GitHub for moving to 2.0. We can start w/ a feature list and add/edit as needed.

[ ] Modularize CSS / functionalize CSS / use modern CSS techniques (purgeCSS, postCSS, etc.)
[ ] Improve a11y by adding aria, sr layouts, etc.
[ ] Continue ensuring that ed. pages pass html validation.
[ ] Revisit JS usage, extract and modularize.
[ ] Simplify configuration, including favicon, etc.
[ ] Employ git hooks and tests for linkrot.
[ ] Provide one-click deployment to Netlify/Heroku.
[ ] Provide better demos other than ed-branded poems.

Incompatible version of bundler

Please ignore: I have resolved the following problems and I am closing this thread.

gem install bundler
Successfully installed bundler-2.0.1
Parsing documentation for bundler-2.0.1
Done installing documentation for bundler after 2 seconds
1 gem installed
bundle install
Fetching gem metadata from https://rubygems.org/..........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Bundler could not find compatible versions for gem "bundler":
  In Gemfile:
    bundler (~> 1.16)

  Current Bundler version:
    bundler (2.0.1)
This Gemfile requires a different version of Bundler.
Perhaps you need to update Bundler by running `gem install bundler`?

Could not find gem 'bundler (~> 1.16)' in any of the relevant sources:
  the local ruby installation

Edit 1: My guess is that that theme has not been updated in a while and the last time it was updated, the latest bundler version was 1.16. So it would seem that the theme does not work with higher versions of bundler. What a shame.

Edit 2: I am getting the exact same error when using the longer, more robust protocol for installation. At this point, I am not sure if it's worth going through all this hassle. I can write simple static websites with just markdown and pandoc and deploy them in minutes.

Feature Request: hypothes.is annotations through `dc.urn` rather than URL

Thought you might be interested to know that, after chatting with the Hypothes.is folks and perusing this post on how Hypothes.is interacts with document metadata, I was able to "migrate" Hypothes.is annotations as I migrated my Ed instance to a new server.

I modified the _include/head.html to include DC metadata using Dublin Core tags with name attributes in addition to the Zotero-friendly property attributes. I also included a few site wide entries in _config.yml. As a result Hypothes.is associates annotations with a urn:x-dc: string rather than the URL.

If it sounds useful to other users, happy to issue a pull request.

is there a way to change favicon.ico

I'm looking to change the image of favicon.ico but when I do, in staging the image is there but then when I close the bundle jekyll --livereload (terminate) and then reinstate the bundle jekyll --livereload. The favicon.ico erases with original favicon.ico ED.

Is it possible to have the favicon.ico permanently placed?

Facebook JS SDK loaded but not used?

The Facebook JS SDK is loaded at

ed/_layouts/default.html

Lines 70 to 86 in c62010e

<!-- Facebook SDK for JavaScript -->
<script>
window.fbAsyncInit = function() {
FB.init({
appId : '589495744558280',
xfbml : true,
version : 'v2.6'
});
};
(function(d, s, id){
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) {return;}
js = d.createElement(s); js.id = id;
js.src = "//connect.facebook.net/en_US/sdk.js";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));
, but as far as I can tell it's only referenced in some meta tags
<meta property="fb:admins" content="elotroalex" />
(though I'm not sure whether those are related to the sdk or general Facebook tagging). The wiki mentions moving its config into _config.yml https://github.com/minicomp/ed/wiki/Version-Roadmap#_configyml , but there's nothing there in the out-of-the-box config.

Is it safe to remove it? Or could its inclusion be made conditional on having the config present in _config.yml?

MathJax does not work with the theme.

I am trying to enable writing LaTex on markdown using MathJax.

The steps to incorporate MathJax:

  • Keep markdown:kramdown in the _config.yml file.
  • Add
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

to head.html

This should make me able to write LaTex code between double-dollar signs in Markdown files, but through Jekyll serve, the content between double-dollar signs is ignored.

For example

---
layout: default
title: Test MathJax
author: YY
---

Before 

$$
A + B = C_a
$$

After

Screenshot 2021-04-18 at 21 39 57

Can anyone help? Thanks.

Cannot use it with Jekyll 4

Hi guys, Is there a way to use it in Jekyll 4?

Bundler could not find compatible versions for gem "bundler":
  In Gemfile:
    bundler (~> 1.16)

  Current Bundler version:
    bundler (2.0.2)
This Gemfile requires a different version of Bundler.
Perhaps you need to update Bundler by running `gem install bundler`?

changing the text width in Ed

I've been trying to change the textwidth of rendered Ed pages without success. The container classes are passed to the theme and seem a logical place to adjust but that doesn't seem to affect the displayed text width. Containers appear in the ed css file as:

/* Slideshow container */
.slideshow-container {
max-width: 1000;
position: relative;
margin: auto;
}

and

/*

  • Container
  • Center the page content.
    */

.container {
/* max-width: 38rem; */
max-width: 38rem;
padding-left: 1rem;
padding-right: 1rem;
margin-left: auto;
margin-right: auto;
}

@media (min-width: 38em) {
.container {
max-width: 32rem;
}
}
@media (min-width: 56em) {
.container {
max-width: 38rem;
}
}

thanks

Could not find gem 'bundler (~> 1.16)'

Tried the robust install. Everything went fine until $bundle install. The error is:

Bundler could not find compatible versions for gem "bundler":
In Gemfile:
bundler (~> 1.16)

Current Bundler version:
bundler (2.0.2)
This Gemfile requires a different version of Bundler.
Perhaps you need to update Bundler by running gem install bundler?

Could not find gem 'bundler (~> 1.16)' in any of the relevant sources:
the local ruby installation

Admittedly, I'm a novice in all this. Have gotten a few Jekyll sites up and running, but far from expert.

Any suggestions?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.