Skip to content

Commit

Permalink
Readium 3.0
Browse files Browse the repository at this point in the history
Remade Readium, moving away from the original Medium copycat. First
iteration. More to come.
  • Loading branch information
svenr-cliqz committed May 17, 2015
1 parent 401dec2 commit 023f505
Show file tree
Hide file tree
Showing 111 changed files with 7,831 additions and 3,197 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Expand Up @@ -3,6 +3,8 @@
.svn
vendor
node_modules
bower_components
.codekit
.sass-cache
assets/fonts/FontAwesome.otf
assets/fonts/fontawesome-webfont.eot
Expand Down
2 changes: 1 addition & 1 deletion LICENSE 100755 → 100644
@@ -1,4 +1,4 @@
Copyright (c) 2014 Ghost Foundation - Released under The MIT License.
Copyright (c) 2013-2015 Ghost Foundation

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
Expand Down
50 changes: 25 additions & 25 deletions README.html
@@ -1,70 +1,70 @@
<h1>Readium 2.0</h1>
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
</head>
<body>
<h1 id="readium3.0.0">Readium 3.0.0</h1>

<p><strong>The Medium-like theme for <a href="https://github.com/TryGhost">Ghost</a></strong>. Reduced to the core design of Medium (without the cluttered
stuff, like the sidebar) to bring you a similar user experience
while giving you the freedom to host it on your own servers and on your own terms.</p>
<p><strong>The (the good parts) Medium-like theme for <a href="https://github.com/TryGhost">Ghost</a></strong>. Took the good parts of Medium (without really looking like Medium) to bring you a similar reading and blogging experience while giving you the freedom to host your content on your own servers and on your own terms.</p>

<p><img src="http://cl.ly/VBX3/readium2.jpg" alt="Readium 2.0" /></p>
<figure>
<img src="http://cl.ly/VBX3/readium2.jpg" alt="Readium 3.0" />
<figcaption>Readium 3.0</figcaption>
</figure>

<p><strong>Check out <a href="http://mark-read.info">Mark Reads Blog</a> as an good example</strong>.</p>
<p><strong>Check out <a href="http://www.svenread.com">Sven Reads Blog</a> as an example</strong>.</p>

<p>Just drop this theme in your Ghost theme folder and choose it in your Ghost admin dashboard (after restarting Ghost).</p>

<p>For big article images in your posts give it the tag &ldquo;articleImage&rdquo;. If this tag gets added to an article, you should add an additional big image
to the beginning. The JS goes out and takes the first image inside this article and uses it as article image.</p>
<p>Just drop this theme in your Ghost theme folder (and exptract it!) and choose it in your Ghost admin dashboard (after restarting Ghost).</p>

<p>If you give your images an alt text, it gets added automatically as figcaption beneath the image (sorry, no links or other HTML stuff). Awesomeness!</p>

<h2>Features</h2>
<h2 id="features">Features</h2>

<ul>
<li>Mobile-First Design Aproach</li>
<li>Fully Responsive layout</li>
<li>Use header images in articles, if you want to (add tag &ldquo;articleImage&rdquo; and first article gets used)</li>
<li>Use header images in articles</li>
<li>Automatic figcaption generation from image alt tags</li>
<li>Valid HTML5/CSS3</li>
<li>WAI-ARIA &amp; Rich Snippets(microdata) roles</li>
<li>Minimal design</li>
<li>Compatible with Ghost 0.5 (Added Multi-User-Support)</li>
<li>Compatible with Ghost 0.6.3</li>
<li>Designed for Readability &amp; Sharability</li>
<li>Works with the Ghost Hosting platform</li>
<li>Handles static pages</li>
<li>Featured article support</li>
<li>FontAwesome implemented for easy use of icons fonts</li>
<li>Google Analytics integrated</li>
<li>Highlight.js integrated for Syntax highlighting - <a href="http://highlightjs.org">Highlight JS</a></li>
<li>OpenGraph &amp; Twitter Cards meta&rsquo;s</li>
<li>OpenGraph &amp; Twitter Cards meta&#8217;s</li>
<li>Free &amp; Open Source Font usage</li>
<li>Theoretically ready for multiple users (here is how to <a href="http://lifewiththemacks.com/multi-user-support/">hack Ghost for Mulit-User</a>)</li>
</ul>


<h4>If your Ghost blog is self hosted:</h4>
<h4 id="ifyourghostblogisselfhosted:">If your Ghost blog is self hosted:</h4>

<ol>
<li>Copy the contents of the .zip file into /content/themes/.</li>
<li>You need to restart your Ghost instance. After that you can switch themes inside your Ghost admin (http://your.domain.com/ghost/settings/general/). Scroll down and choose &ldquo;Readium&rdquo; from the theme dropdown.</li>
<li>Copy the contents of the .zip file into /content/themes/ and unzip it.</li>
<li>You need to restart your Ghost instance. After that you can switch themes inside your Ghost admin (http://your.domain.com/ghost/settings/general/). Scroll down and choose &#8220;Readium&#8221; from the theme dropdown.</li>
<li>Now you can customize your logo, langing page image (if you choose to have one), as well as user images and texts to fit the theme.</li>
<li>Have fun.</li>
</ol>


<h4>If your Ghost blog is hosted on the Ghost hosting platform:</h4>
<h4 id="ifyourghostblogishostedontheghosthostingplatform:">If your Ghost blog is hosted on the Ghost hosting platform:</h4>

<ol>
<li>Upload your Zip file via the Ghost admin panel.</li>
<li>Switch your theme to the Readium theme.</li>
<li>Have fun.</li>
</ol>


<h4>Thanks go to&hellip;</h4>
<h4 id="thanksgoto...">Thanks go to&#8230;</h4>

<ul>
<li>FontAwesome by Dave Gandy</li>
<li>Highlight JS by Ivan Sagalaev</li>
<li>@mr_boolean, @riplexus &amp; @unverbraucht for helping with JS</li>
<li>The awesome guys that make Ghost</li>
<li>The really rad guys that design Medium</li>
</ul>

</body>
</html>
25 changes: 7 additions & 18 deletions README.md 100755 → 100644
@@ -1,41 +1,31 @@
# Readium 2.0.0
**The Medium-like theme for [Ghost](https://github.com/TryGhost)**. Reduced to the core design of Medium (without the cluttered
stuff, like the sidebar) to bring you a similar user experience
while giving you the freedom to host it on your own servers and on your own terms.
# Readium 3.0.0
**The (the good parts) Medium-like theme for [Ghost](https://github.com/TryGhost)**. Took the good parts of Medium (without really looking like Medium) to bring you a similar reading and blogging experience while giving you the freedom to host your content on your own servers and on your own terms.

![Readium 2.0](http://cl.ly/VBX3/readium2.jpg)
![Readium 3.0](http://cl.ly/VBX3/readium2.jpg)

**Check out [Mark Reads Blog](http://mark-read.info) as an good example**.
**Check out [Sven Reads Blog](http://www.svenread.com) as an example**.

Just drop this theme in your Ghost theme folder and choose it in your Ghost admin dashboard (after restarting Ghost).

For big article images in your posts give it the tag "articleImage". If this tag gets added to an article, you should add an additional big image
to the beginning. The JS goes out and takes the first image inside this article and uses it as article image.
Just drop this theme in your Ghost theme folder (and exptract it!) and choose it in your Ghost admin dashboard (after restarting Ghost).

If you give your images an alt text, it gets added automatically as figcaption beneath the image (sorry, no links or other HTML stuff). Awesomeness!

## Features
- Mobile-First Design Aproach
- Fully Responsive layout
- Use header images in articles, if you want to (add tag "articleImage" and first article gets used)
- Use header images in articles
- Automatic figcaption generation from image alt tags
- Valid HTML5/CSS3
- WAI-ARIA & Rich Snippets(microdata) roles
- Minimal design
- Compatible with Ghost 0.5 (Added Multi-User-Support)
- Compatible with Ghost 0.6.3
- Designed for Readability & Sharability
- Works with the Ghost Hosting platform
- Handles static pages
- Featured article support
- FontAwesome implemented for easy use of icons fonts
- Google Analytics integrated
- Highlight.js integrated for Syntax highlighting - [Highlight JS](http://highlightjs.org)
- OpenGraph & Twitter Cards meta's
- Free & Open Source Font usage
- Theoretically ready for multiple users (here is how to [hack Ghost for Mulit-User](http://lifewiththemacks.com/multi-user-support/))

### Comments
To enable the disqus support open the file partials/comment-list.hbs and follow the instruction.

#### If your Ghost blog is self hosted:
1. Copy the contents of the .zip file into /content/themes/ and unzip it.
Expand All @@ -51,6 +41,5 @@ To enable the disqus support open the file partials/comment-list.hbs and follow
#### Thanks go to...
- FontAwesome by Dave Gandy
- Highlight JS by Ivan Sagalaev
- @mr_boolean, @riplexus & @unverbraucht for helping with JS
- The awesome guys that make Ghost
- The really rad guys that design Medium

0 comments on commit 023f505

Please sign in to comment.