Skip to content

Commit

Permalink
expanded feature set
Browse files Browse the repository at this point in the history
  • Loading branch information
elotroalex committed Feb 1, 2016
1 parent 64a37a7 commit 00e7a12
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 14 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,18 @@ Ed is built on top of [Lanyon](https://github.com/poole/lanyon), a Jekyll theme



## Features
- Design choices emphasizing a pleasant reading experience of narrative, drama and poetry
- Extensible, minimal structure
- Responsive and sensible footnote system
- Dublin Core metadata for Zotero recognition to aid in citation
- Ability to generate well-formatted bibliographies using [jekyll-scholar](https://github.com/inukshuk/jekyll-scholar) by [Sylvester Keil](https://github.com/inukshuk/)
## 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- bandwitdh scenarios
- Easier for digital archives and libraries to preserve
- Open source, open access
- Unobtrusive footnotes
- Works well with Zotero
- Ability to generate well-formatted bibliographies and linked citations using [jekyll-scholar](https://github.com/inukshuk/jekyll-scholar) by [Sylvester Keil](https://github.com/inukshuk/)
- Annotations via [hypothes.is](https://hypothes.is/)

## Installing and using Ed

To learn how to install and begin using, Ed, please visit our [documentation page](https://github.com/elotroalex/ed/blob/master/documentation.md).
To learn how to install and begin using Ed, please visit our [documentation page](https://github.com/elotroalex/ed/blob/master/documentation.md).
17 changes: 11 additions & 6 deletions about.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,17 @@ Ed is a [Jekyll](https://jekyllrb.com/

Ed is built on top of [Lanyon](https://github.com/poole/lanyon), a Jekyll theme based on [Poole](http://getpoole.com), "the Jekyll butler," both created by [Mark Otto](<https://github.com/mdo) and distributed with an MIT license. Thanks to Mark Otto for his helpful streamlining.

## Features
- Design choices emphasizing a pleasant reading experience of narrative, drama and poetry
- Extensible, minimal structure
- Responsive and sensible footnote system
- Dublin Core metadata for Zotero recognition to aid in citation
- Ability to generate well-formatted bibliographies using [jekyll-scholar](https://github.com/inukshuk/jekyll-scholar) by [Sylvester Keil](https://github.com/inukshuk/)
## 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- bandwitdh scenarios
- Easier for digital archives and libraries to preserve
- Open source, open access
- Unobtrusive footnotes
- Works well with Zotero
- Ability to generate well-formatted bibliographies and linked citations using [jekyll-scholar](https://github.com/inukshuk/jekyll-scholar) by [Sylvester Keil](https://github.com/inukshuk/)
- Annotations via [hypothes.is](https://hypothes.is/)



2 changes: 1 addition & 1 deletion documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ Besides the homepage, Ed ships with an About page, `about.md` and a Bibliography
- 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 to leverage the power of Google's [site search operator](https://moz.com/blog/25-killer-combos-for-googles-site-operator) to search within your site. 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/`.
- 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. To allow annotations on your site you can simply replace our URL with yours. Make sure to visit [hypothes.is](https://hypothes.is/) to learn more.
- Ed includes RDF metadata in the headers that makes it easier for users of Zotero to grab bibliographic information for the site and individual texts. The RDF functionality is not enough to generate a full proper citation. Consider providing proper 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)".

Expand Down

0 comments on commit 00e7a12

Please sign in to comment.