Skip to content

Commit

Permalink
Rlease v1.0.0
Browse files Browse the repository at this point in the history
Update HTML Live Preview links and tag as release v1.0.0.

This is the last version of gh-themes-magick that will support pandoc v1 (v1.19.x).

The next release will be v2.0.0 and work with pandoc version >= 2.0.0.
  • Loading branch information
tajmone committed Mar 3, 2018
1 parent c990c2f commit 13637a9
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 31 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,18 +356,18 @@ All themes also contains a copy of the [**highlight.js**](https://highlightjs.or
[Time Machine x300]: https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/timemachine.gif "Time Machine theme screenshot"


[Architect HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/architect/index.html "Architect theme live preview"
[Cayman HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/cayman/index.html "Cayman theme live preview"
[Dinky HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/dinky/index.html "Dinky theme live preview"
[Hack HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/hack/index.html "Hack theme live preview"
[Leap Day HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/leapday/index.html "Leap Day theme live preview"
[Merlot HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/merlot/index.html "Merlot theme live preview"
[Midnight HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/midnight/index.html "Midnight theme live preview"
[Minimal HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/minimal/index.html "Minimal theme live preview"
[Modernist HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/modernist/index.html "Modernist theme live preview"
[Slate HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/slate/index.html "Slate theme live preview"
[Tactile HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/tactile/index.html "Tactile theme live preview"
[Time Machine HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/timemachine/index.html "Time Machine theme live preview"
[Architect HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/architect/index.html "Architect theme live preview"
[Cayman HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/cayman/index.html "Cayman theme live preview"
[Dinky HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/dinky/index.html "Dinky theme live preview"
[Hack HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/hack/index.html "Hack theme live preview"
[Leap Day HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/leapday/index.html "Leap Day theme live preview"
[Merlot HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/merlot/index.html "Merlot theme live preview"
[Midnight HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/midnight/index.html "Midnight theme live preview"
[Minimal HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/minimal/index.html "Minimal theme live preview"
[Modernist HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/modernist/index.html "Modernist theme live preview"
[Slate HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/slate/index.html "Slate theme live preview"
[Tactile HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/tactile/index.html "Tactile theme live preview"
[Time Machine HTML Prev]: https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/timemachine/index.html "Time Machine theme live preview"



Expand All @@ -379,4 +379,5 @@ All themes also contains a copy of the [**highlight.js**](https://highlightjs.or
[CCBY4]: https://creativecommons.org/licenses/by/4.0/
[CCBY3]: https://creativecommons.org/licenses/by/3.0/
[MIT Leap Day]: https://github.com/mattgraham/leapday/blob/master/LICENCE
[MIT Merlot]: https://github.com/cameronmcefee/merlot/blob/master/LICENSE
[MIT Merlot]: https://github.com/cameronmcefee/merlot/blob/master/LICENSE

2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h3>🡸 Give <strong>gh-themes-magick</strong> a star!</h3>
RewriteCond %{REQUEST_URI} ^/([^/.]+)\.html$ [NC]
RewriteCond ${map:${lower:%1}|NOT_FOUND} !NOT_FOUND
RewriteRule .? /index.php?q=${map:${lower:%1}} [NC,L]
&lt;/Location&gt;</code></pre><hr /><h1 id="available-themes">Available Themes</h1><p>Currently, <b><strong>5</strong> of the <strong>12</strong> GitHub themes have been ported to <strong>gh-themes-magick</strong></b>, the one used by this site (Architect, by Jason Long) being one of them.</p><p>Click on the thumbnails to see a live preview of the other four:</p><table><colgroup><col style="width: 53%" /><col style="width: 46%" /></colgroup><thead><tr class="header"><th style="text-align: center;"><h2>Cayman</h2></th><th style="text-align: center;"><h2>Dinky</h2></th></tr></thead><tbody><tr class="odd"><td style="text-align: center;">by Jason Long</td><td style="text-align: center;">by Diana Mounter</td></tr><tr class="even"><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/cayman/index.html" title="Cayman theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/cayman.gif" title="Cayman theme screenshot" alt="Cayman" /></a></td><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/dinky/index.html" title="Dinky theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/dinky.gif" title="Dinky theme screenshot" alt="Dinky" /></a></td></tr><tr class="odd"><td style="text-align: center;">CC-BY 4.0</td><td style="text-align: center;">CC-BY 3.0</td></tr></tbody></table><table><colgroup><col style="width: 53%" /><col style="width: 46%" /></colgroup><thead><tr class="header"><th style="text-align: center;"><h2>Leap Day</h2></th><th style="text-align: center;"><h2>Merlot</h2></th></tr></thead><tbody><tr class="odd"><td style="text-align: center;">by Matt Graham</td><td style="text-align: center;">by Cameron McEfee</td></tr><tr class="even"><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/leapday/index.html" title="Leap Day theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/leapday.gif" title="Leap Day theme screenshot" alt="Leap Day" /></a></td><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/baf5927/gh-themes/merlot/index.html" title="Merlot theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/merlot.gif" title="Merlot theme screenshot" alt="Merlot" /></a></td></tr><tr class="odd"><td style="text-align: center;">CC BY-SA 3.0</td><td style="text-align: center;">MIT</td></tr></tbody></table><hr /><h1 id="setting-up-a-website">Setting up a Website</h1><p>These are the steps:</p><ol><li>Install <a href="https://github.com/jgm/pandoc/releases/latest"><strong>pandoc</strong></a></li><li>Get <a href="https://github.com/tajmone/gh-themes-magick"><strong>gh-themes-magick</strong></a></li><li>Choose a theme</li><li>Copy it to your repo’s <code>master</code> branch</li><li>Rename the theme folder to <code>/docs/</code></li><li>Fill-in the YAML config file</li><li>Run the <code>abracadabra</code> script</li><li>Commit and push changes</li><li>Set GitHub Pages to publish from <code>/master/</code> branch <code>/docs/</code> folder</li></ol><p>That’s it! Your project website is now live.</p><p>(<a href="https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch">Click here to view GitHub’s Help on how to configure a publishing source for GitHub Pages</a>)</p><hr /><h1 id="updating-its-contents">Updating Its Contents</h1><p>Whenever you want to update your website to mirror the contents of your repo’s <code>README.md</code>:</p><ol><li>Run the <code>abracadabra</code> script</li><li>Commit and push changes to <code>master</code></li></ol><p>For detailed instructions on setup and customization, refer to the project’s documentation and <a href="https://github.com/tajmone/gh-themes-magick/wiki">online Wiki</a>.</p><hr /><h1 id="licenses-and-credits">Licenses and Credits</h1><p><strong>gh-themes-magick</strong> is copyright © 2016, Tristano Ajmone (<a href="https://github.com/tajmone">@tajmone</a>).</p><p><strong>gh-themes-magick</strong> is released under the <strong>Creative Common Attribution 4.0</strong> International License (CC BY 4.0). <b>The project is built around third party themes</b>, each one isolated in its own folder and <b>each released under the terms of its upstream license</b>:</p><table><thead><tr class="header"><th>THEME</th><th>AUTHOR</th><th>FOLDER</th><th style="text-align: center;">LICENSE</th></tr></thead><tbody><tr class="odd"><td><a href="https://github.com/jasonlong/architect-theme" title="Architect theme project page">Architect</a></td><td>Jason Long</td><td><code>/gh-themes/architect/</code></td><td style="text-align: center;">CC-BY 4.0</td></tr><tr class="even"><td><a href="https://github.com/jasonlong/cayman-theme" title="Cayman theme project page">Cayman</a></td><td>Jason Long</td><td><code>/gh-themes/cayman/</code></td><td style="text-align: center;">CC-BY 4.0</td></tr><tr class="odd"><td><a href="https://github.com/broccolini/dinky" title="Dinky theme project page">Dinky</a></td><td>Diana Mounter</td><td><code>/gh-themes/dinky/</code></td><td style="text-align: center;">CC-BY 3.0</td></tr><tr class="even"><td><a href="https://github.com/mattgraham/leapday" title="Leap Day theme project page">Leap Day</a></td><td>Matt Graham</td><td><code>/gh-themes/leapday/</code></td><td style="text-align: center;">CC-BY 3.0 + MIT</td></tr><tr class="odd"><td><a href="https://github.com/cameronmcefee/merlot" title="Merlot theme project page">Merlot</a></td><td>Cameron McEfee</td><td><code>/gh-themes/merlot/</code></td><td style="text-align: center;">MIT</td></tr></tbody></table><p>Detailed information on the themes’ licenses, and about the adaptative changes made to the original code and resources, can be found in each theme’s folder, inside the <code>LICENSE</code> and <code>CHANGELIST</code> files.</p><p>All themes also contains a copy of the <a href="https://highlightjs.org"><strong>highlight.js</strong></a> library and one of its CSS themes. <b><strong>Highlight.js</strong> is copyright © 2006, <a href="https://github.com/isagalaev">Ivan Sagalaev</a>, released under BSD-3-Clause License.</b> The following highlight.js themes have been included in <strong>gh-themes-magick</strong> (some with changes):</p><ul><li><a href="https://github.com/isagalaev/highlight.js/blob/master/src/styles/github-gist.css"><strong>GitHub Gist</strong></a>” by <a href="https://github.com/LouisBarranqueiro">Louis Barranqueiro</a>.</li><li><a href="https://github.com/isagalaev/highlight.js/blob/master/src/styles/docco.css"><strong>Docco</strong></a>”, coverted from <a href="http://jashkenas.github.io/docco/">Docco</a> by <a href="https://github.com/thingsinjars">Simon Madine</a>.</li><li><a href="https://github.com/isagalaev/highlight.js/blob/master/src/styles/hybrid.css"><strong>VIM-Hybrid</strong></a> by w0ng (<a href="https://github.com/w0ng/vim-hybrid" class="uri">https://github.com/w0ng/vim-hybrid</a>)</li></ul><p><b>Tristano Ajmone (<a href="https://github.com/tajmone">@tajmone</a>) is the creator an maintainer of the <strong>gh-themes-magick</strong> project.</b> First released in December, 2016.</p>
&lt;/Location&gt;</code></pre><hr /><h1 id="available-themes">Available Themes</h1><p>Currently, <b><strong>5</strong> of the <strong>12</strong> GitHub themes have been ported to <strong>gh-themes-magick</strong></b>, the one used by this site (Architect, by Jason Long) being one of them.</p><p>Click on the thumbnails to see a live preview of the other four:</p><table><colgroup><col style="width: 53%" /><col style="width: 46%" /></colgroup><thead><tr class="header"><th style="text-align: center;"><h2>Cayman</h2></th><th style="text-align: center;"><h2>Dinky</h2></th></tr></thead><tbody><tr class="odd"><td style="text-align: center;">by Jason Long</td><td style="text-align: center;">by Diana Mounter</td></tr><tr class="even"><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/cayman/index.html" title="Cayman theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/cayman.gif" title="Cayman theme screenshot" alt="Cayman" /></a></td><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/dinky/index.html" title="Dinky theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/dinky.gif" title="Dinky theme screenshot" alt="Dinky" /></a></td></tr><tr class="odd"><td style="text-align: center;">CC-BY 4.0</td><td style="text-align: center;">CC-BY 3.0</td></tr></tbody></table><table><colgroup><col style="width: 53%" /><col style="width: 46%" /></colgroup><thead><tr class="header"><th style="text-align: center;"><h2>Leap Day</h2></th><th style="text-align: center;"><h2>Merlot</h2></th></tr></thead><tbody><tr class="odd"><td style="text-align: center;">by Matt Graham</td><td style="text-align: center;">by Cameron McEfee</td></tr><tr class="even"><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/leapday/index.html" title="Leap Day theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/leapday.gif" title="Leap Day theme screenshot" alt="Leap Day" /></a></td><td style="text-align: center;"><a href="https://cdn.rawgit.com/tajmone/gh-themes-magick/c990c2f/gh-themes/merlot/index.html" title="Merlot theme live preview"><img src="https://github.com/tajmone/gh-themes-magick/raw/master/images/themes-thumbs/300/merlot.gif" title="Merlot theme screenshot" alt="Merlot" /></a></td></tr><tr class="odd"><td style="text-align: center;">CC BY-SA 3.0</td><td style="text-align: center;">MIT</td></tr></tbody></table><hr /><h1 id="setting-up-a-website">Setting up a Website</h1><p>These are the steps:</p><ol><li>Install <a href="https://github.com/jgm/pandoc/releases/latest"><strong>pandoc</strong></a></li><li>Get <a href="https://github.com/tajmone/gh-themes-magick"><strong>gh-themes-magick</strong></a></li><li>Choose a theme</li><li>Copy it to your repo’s <code>master</code> branch</li><li>Rename the theme folder to <code>/docs/</code></li><li>Fill-in the YAML config file</li><li>Run the <code>abracadabra</code> script</li><li>Commit and push changes</li><li>Set GitHub Pages to publish from <code>/master/</code> branch <code>/docs/</code> folder</li></ol><p>That’s it! Your project website is now live.</p><p>(<a href="https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch">Click here to view GitHub’s Help on how to configure a publishing source for GitHub Pages</a>)</p><hr /><h1 id="updating-its-contents">Updating Its Contents</h1><p>Whenever you want to update your website to mirror the contents of your repo’s <code>README.md</code>:</p><ol><li>Run the <code>abracadabra</code> script</li><li>Commit and push changes to <code>master</code></li></ol><p>For detailed instructions on setup and customization, refer to the project’s documentation and <a href="https://github.com/tajmone/gh-themes-magick/wiki">online Wiki</a>.</p><hr /><h1 id="licenses-and-credits">Licenses and Credits</h1><p><strong>gh-themes-magick</strong> is copyright © 2016, Tristano Ajmone (<a href="https://github.com/tajmone">@tajmone</a>).</p><p><strong>gh-themes-magick</strong> is released under the <strong>Creative Common Attribution 4.0</strong> International License (CC BY 4.0). <b>The project is built around third party themes</b>, each one isolated in its own folder and <b>each released under the terms of its upstream license</b>:</p><table><thead><tr class="header"><th>THEME</th><th>AUTHOR</th><th>FOLDER</th><th style="text-align: center;">LICENSE</th></tr></thead><tbody><tr class="odd"><td><a href="https://github.com/jasonlong/architect-theme" title="Architect theme project page">Architect</a></td><td>Jason Long</td><td><code>/gh-themes/architect/</code></td><td style="text-align: center;">CC-BY 4.0</td></tr><tr class="even"><td><a href="https://github.com/jasonlong/cayman-theme" title="Cayman theme project page">Cayman</a></td><td>Jason Long</td><td><code>/gh-themes/cayman/</code></td><td style="text-align: center;">CC-BY 4.0</td></tr><tr class="odd"><td><a href="https://github.com/broccolini/dinky" title="Dinky theme project page">Dinky</a></td><td>Diana Mounter</td><td><code>/gh-themes/dinky/</code></td><td style="text-align: center;">CC-BY 3.0</td></tr><tr class="even"><td><a href="https://github.com/mattgraham/leapday" title="Leap Day theme project page">Leap Day</a></td><td>Matt Graham</td><td><code>/gh-themes/leapday/</code></td><td style="text-align: center;">CC-BY 3.0 + MIT</td></tr><tr class="odd"><td><a href="https://github.com/cameronmcefee/merlot" title="Merlot theme project page">Merlot</a></td><td>Cameron McEfee</td><td><code>/gh-themes/merlot/</code></td><td style="text-align: center;">MIT</td></tr></tbody></table><p>Detailed information on the themes’ licenses, and about the adaptative changes made to the original code and resources, can be found in each theme’s folder, inside the <code>LICENSE</code> and <code>CHANGELIST</code> files.</p><p>All themes also contains a copy of the <a href="https://highlightjs.org"><strong>highlight.js</strong></a> library and one of its CSS themes. <b><strong>Highlight.js</strong> is copyright © 2006, <a href="https://github.com/isagalaev">Ivan Sagalaev</a>, released under BSD-3-Clause License.</b> The following highlight.js themes have been included in <strong>gh-themes-magick</strong> (some with changes):</p><ul><li><a href="https://github.com/isagalaev/highlight.js/blob/master/src/styles/github-gist.css"><strong>GitHub Gist</strong></a>” by <a href="https://github.com/LouisBarranqueiro">Louis Barranqueiro</a>.</li><li><a href="https://github.com/isagalaev/highlight.js/blob/master/src/styles/docco.css"><strong>Docco</strong></a>”, coverted from <a href="http://jashkenas.github.io/docco/">Docco</a> by <a href="https://github.com/thingsinjars">Simon Madine</a>.</li><li><a href="https://github.com/isagalaev/highlight.js/blob/master/src/styles/hybrid.css"><strong>VIM-Hybrid</strong></a> by w0ng (<a href="https://github.com/w0ng/vim-hybrid" class="uri">https://github.com/w0ng/vim-hybrid</a>)</li></ul><p><b>Tristano Ajmone (<a href="https://github.com/tajmone">@tajmone</a>) is the creator an maintainer of the <strong>gh-themes-magick</strong> project.</b> First released in December, 2016.</p>
<div id="starmereminder">
<iframe style="float:left" src="https://ghbtns.com/github-btn.html?user=tajmone&repo=gh-themes-magick&type=star&count=true&size=large" frameborder="0" scrolling="0" width="160px" height="30px"></iframe>
<h3>🡸 Don’t forget to star <strong>gh-themes-magick</strong>!</h3>
Expand Down
Loading

0 comments on commit 13637a9

Please sign in to comment.