Git Product home page Git Product logo

11tyed's Introduction

Eleventyed: Further experiments with the JAM stack

A fork of Ed as a means of exploring Eleventy static site generator for Digital Scholarship.

Converting a Jekyll theme into an Eleventy project

Is it worth it? After some experimentation, answer is yes! While Eleventy is more flexible, the default structure of Jekyll plays nicely with Eleventy.

Things to keep in mind:

  • Eleventy does not have a pages variable (cf., _includes/sidebar.html) -- need to create a pages collection the Eleventy way
  • Removing references to page parent object at the template level (except page.url), i.e., page.title --> title in most Liquid templating
  • Collection items attributes are accessed through the data key (i.e., item.data.title)
  • Need to add _layouts to the Eleventy build (cf. .eleventy.js)
  • Template content is accessed through templateContent key (cf. assets/js/search.js 21: text.content)
  • Eleventy interprets all templates as liquid in addition to anything else -- if you need it to do otherwise have to be explicit about it (cf. documentation.md templateEngineOverride)
  • Typographic kinks
    • Smartquotes (cf. .eleventy.js MarkdownIt parameters)
    • Parsing markdown footnotes (cf. markdown-it-footnote plugin)
    • Using Kramdown style inline attributes ({.mycoolclass}) -- not quite Kramdown, but Pandoc style
    • Markdown table of contents
  • Have to implement any custom filters by hand, for example, the Jekyll/Liquid filter jsonify (cf. .eleventy.js filter addition)
  • Have to add Sass to Eleventy build yourself if you're into that kind of thing

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.

11tyed's People

Contributors

apjanco avatar joseavergara avatar atmcgrath avatar bulbil avatar

Stargazers

Alex Wermer-Colan avatar

Watchers

James Cloos avatar  avatar

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.