mirrors
/
org-html-themes
mirror of https://github.com/fniessen/org-html-themes.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve introduction

pull/29/head
Fabrice Niessen 2015-05-29 13:15:19 +02:00
parent 1c8fe3d0b1
commit 79d27edb62
2 changed files with 613 additions and 593 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
README.html
View File

@ -25,41 +25,41 @@
<h2>Table of Contents</h2> <h2>Table of Contents</h2>
<div id="text-table-of-contents"> <div id="text-table-of-contents">
<ul> <ul>
<li><a href="#orgheadline4">1. Overview</a> <li><a href="#orgheadline3">1. Overview</a>
<ul> <ul>
<li><a href="#orgheadline1">1.1. Description</a></li> <li><a href="#orgheadline1">1.1. Description</a></li>
<li><a href="#orgheadline2">1.2. Objective</a></li> <li><a href="#orgheadline2">1.2. Requirements</a></li>
<li><a href="#orgheadline3">1.3. Requirements</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgheadline7">2. Quotations</a> <li><a href="#orgheadline6">2. Quotations</a>
<ul> <ul>
<li><a href="#orgheadline5">2.1. About Bigblow</a></li> <li><a href="#orgheadline4">2.1. About Bigblow</a></li>
<li><a href="#orgheadline6">2.2. About ReadTheOrg</a></li> <li><a href="#orgheadline5">2.2. About ReadTheOrg</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgheadline10">3. Gallery</a> <li><a href="#orgheadline9">3. Gallery</a>
<ul> <ul>
<li><a href="#orgheadline8">3.1. Bigblow</a></li> <li><a href="#orgheadline7">3.1. Bigblow</a></li>
<li><a href="#orgheadline9">3.2. ReadTheOrg</a></li> <li><a href="#orgheadline8">3.2. ReadTheOrg</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgheadline11">4. Demo</a></li> <li><a href="#orgheadline10">4. Demo</a></li>
<li><a href="#orgheadline15">5. Installing a theme</a> <li><a href="#orgheadline14">5. Installing a theme</a>
<ul> <ul>
<li><a href="#orgheadline13">5.1. Bigblow</a> <li><a href="#orgheadline12">5.1. Bigblow</a>
<ul> <ul>
<li><a href="#orgheadline12">Local version</a></li> <li><a href="#orgheadline11">Local version</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgheadline14">5.2. ReadTheOrg</a></li> <li><a href="#orgheadline13">5.2. ReadTheOrg</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgheadline19">6. Contributing</a> <li><a href="#orgheadline19">6. Contributing</a>
<ul> <ul>
<li><a href="#orgheadline16">6.1. Issues</a></li> <li><a href="#orgheadline15">6.1. Issues</a></li>
<li><a href="#orgheadline17">6.2. Patches</a></li> <li><a href="#orgheadline16">6.2. Patches</a></li>
<li><a href="#orgheadline18">6.3. Donations</a></li> <li><a href="#orgheadline17">6.3. Donations</a></li>
<li><a href="#orgheadline18">6.4. Follow me</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgheadline20">7. License</a></li> <li><a href="#orgheadline20">7. License</a></li>
@ -74,35 +74,39 @@
<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" /> <img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" />
</a> </a>
<div id="outline-container-orgheadline4" class="outline-2"> <div id="outline-container-orgheadline3" class="outline-2">
<h2 id="orgheadline4"><span class="section-number-2">1</span> Overview</h2> <h2 id="orgheadline3"><span class="section-number-2">1</span> Overview</h2>
<div class="outline-text-2" id="text-1"> <div class="outline-text-2" id="text-1">
</div><div id="outline-container-orgheadline1" class="outline-3"> </div><div id="outline-container-orgheadline1" class="outline-3">
<h3 id="orgheadline1"><span class="section-number-3">1.1</span> Description</h3> <h3 id="orgheadline1"><span class="section-number-3">1.1</span> Description</h3>
<div class="outline-text-3" id="text-1-1"> <div class="outline-text-3" id="text-1-1">
<p> <p>
Org mode provides basic HTML support. Though, we can easily override CSS Though you can easily override CSS stylesheets and add your own HTML themes, we
stylesheets and add our own HTML themes. can say (or write) that Org mode provides a <i>basic</i> HTML support.
</p>
<p>
<b>Org-HMTL themes</b> is an open source framework for providing you with a list of
very nice (cross-browser) themes for all your Org documents. Use them, and your
colleagues will come up to tell you that you are a genius!
</p>
<p>
Share this content by tweeting this page:
</p> </p>
<script src="http://platform.twitter.com/widgets.js"></script> <script src="http://platform.twitter.com/widgets.js"></script>
<a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a> <a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a>
</div>
</div>
<div id="outline-container-orgheadline2" class="outline-3">
<h3 id="orgheadline2"><span class="section-number-3">1.2</span> Objective</h3>
<div class="outline-text-3" id="text-1-2">
<p> <p>
The goal of the <b>Org-HMTL themes</b> is to provide you with a list of very nice Follow <a href="https://twitter.com/f_niessen">f_niessen</a> on Twitter for updates on Org-HTML themes!
(cross-browser) themes.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline3" class="outline-3"> <div id="outline-container-orgheadline2" class="outline-3">
<h3 id="orgheadline3"><span class="section-number-3">1.3</span> Requirements</h3> <h3 id="orgheadline2"><span class="section-number-3">1.2</span> Requirements</h3>
<div class="outline-text-3" id="text-1-3"> <div class="outline-text-3" id="text-1-2">
<p> <p>
Org mode version 8 (or later) is required. Org mode version 8 (or later) is required.
</p> </p>
@ -114,11 +118,11 @@ If such a version is not bundled with your Emacs, install one from ELPA.
</div> </div>
</div> </div>
<div id="outline-container-orgheadline7" class="outline-2"> <div id="outline-container-orgheadline6" class="outline-2">
<h2 id="orgheadline7"><span class="section-number-2">2</span> Quotations</h2> <h2 id="orgheadline6"><span class="section-number-2">2</span> Quotations</h2>
<div class="outline-text-2" id="text-2"> <div class="outline-text-2" id="text-2">
</div><div id="outline-container-orgheadline5" class="outline-3"> </div><div id="outline-container-orgheadline4" class="outline-3">
<h3 id="orgheadline5"><span class="section-number-3">2.1</span> About Bigblow</h3> <h3 id="orgheadline4"><span class="section-number-3">2.1</span> About Bigblow</h3>
<div class="outline-text-3" id="text-2-1"> <div class="outline-text-3" id="text-2-1">
<p> <p>
&ldquo;Very very nice, I enjoy it a lot.&rdquo; <br /> &ldquo;Very very nice, I enjoy it a lot.&rdquo; <br />
@ -159,8 +163,8 @@ wonderful package!&rdquo; <br />
</div> </div>
</div> </div>
<div id="outline-container-orgheadline6" class="outline-3"> <div id="outline-container-orgheadline5" class="outline-3">
<h3 id="orgheadline6"><span class="section-number-3">2.2</span> About ReadTheOrg</h3> <h3 id="orgheadline5"><span class="section-number-3">2.2</span> About ReadTheOrg</h3>
<div class="outline-text-3" id="text-2-2"> <div class="outline-text-3" id="text-2-2">
<p> <p>
&ldquo;OMG. The ReadTheOrg theme for exported HTML from org mode files is eye &ldquo;OMG. The ReadTheOrg theme for exported HTML from org mode files is eye
@ -187,8 +191,8 @@ this theme.&rdquo; <br />
</div> </div>
</div> </div>
<div id="outline-container-orgheadline10" class="outline-2"> <div id="outline-container-orgheadline9" class="outline-2">
<h2 id="orgheadline10"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class="section-number-2">3</span> Gallery</h2> <h2 id="orgheadline9"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class="section-number-2">3</span> Gallery</h2>
<div class="outline-text-2" id="text-3"> <div class="outline-text-2" id="text-3">
<p> <p>
This is a list of available <b>HTML themes for Org mode</b>, which you can use right This is a list of available <b>HTML themes for Org mode</b>, which you can use right
@ -196,8 +200,8 @@ now! Well, I hope to have more than one in a couple of weeks&#x2026;
</p> </p>
</div> </div>
<div id="outline-container-orgheadline8" class="outline-3"> <div id="outline-container-orgheadline7" class="outline-3">
<h3 id="orgheadline8"><span class="section-number-3">3.1</span> Bigblow</h3> <h3 id="orgheadline7"><span class="section-number-3">3.1</span> Bigblow</h3>
<div class="outline-text-3" id="text-3-1"> <div class="outline-text-3" id="text-3-1">
<p> <p>
Bigblow is perfect for your work: it is a clean design aimed at optimal <b>Org Bigblow is perfect for your work: it is a clean design aimed at optimal <b>Org
@ -297,8 +301,8 @@ Keyboard shortcuts to save time and boost your productivity:
</div> </div>
</div> </div>
<div id="outline-container-orgheadline9" class="outline-3"> <div id="outline-container-orgheadline8" class="outline-3">
<h3 id="orgheadline9"><span class="section-number-3">3.2</span> ReadTheOrg</h3> <h3 id="orgheadline8"><span class="section-number-3">3.2</span> ReadTheOrg</h3>
<div class="outline-text-3" id="text-3-2"> <div class="outline-text-3" id="text-3-2">
<p> <p>
ReadTheOrg is a clone of the official &#x2013; and great! &#x2013; theme (called <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx</a>) ReadTheOrg is a clone of the official &#x2013; and great! &#x2013; theme (called <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx</a>)
@ -333,8 +337,8 @@ default structure of the HTML export)!
</div> </div>
</div> </div>
<div id="outline-container-orgheadline11" class="outline-2"> <div id="outline-container-orgheadline10" class="outline-2">
<h2 id="orgheadline11"><span class="section-number-2">4</span> Demo</h2> <h2 id="orgheadline10"><span class="section-number-2">4</span> Demo</h2>
<div class="outline-text-2" id="text-4"> <div class="outline-text-2" id="text-4">
<p> <p>
I&rsquo;ve written a demo page for the themes that provides a maximal working support I&rsquo;ve written a demo page for the themes that provides a maximal working support
@ -348,11 +352,11 @@ admonitions, footnotes, tables and other details.
</div> </div>
</div> </div>
<div id="outline-container-orgheadline15" class="outline-2"> <div id="outline-container-orgheadline14" class="outline-2">
<h2 id="orgheadline15"><span class="section-number-2">5</span> Installing a theme</h2> <h2 id="orgheadline14"><span class="section-number-2">5</span> Installing a theme</h2>
<div class="outline-text-2" id="text-5"> <div class="outline-text-2" id="text-5">
<p> <p>
Using a theme from the <a href="#orgheadline10">theme gallery</a> for your own Org documents is very easy: Using a theme from the <a href="#orgheadline9">theme gallery</a> for your own Org documents is very easy:
you just need to clone the Org-HTML themes project, add a <code>#+SETUPFILE:</code> directive you just need to clone the Org-HTML themes project, add a <code>#+SETUPFILE:</code> directive
in the preamble to include the CSS and JavaScript files, then export your Org in the preamble to include the CSS and JavaScript files, then export your Org
mode file to HTML. mode file to HTML.
@ -395,8 +399,8 @@ C-e h h</code>.
</p> </p>
</div> </div>
<div id="outline-container-orgheadline13" class="outline-3"> <div id="outline-container-orgheadline12" class="outline-3">
<h3 id="orgheadline13"><span class="section-number-3">5.1</span> Bigblow</h3> <h3 id="orgheadline12"><span class="section-number-3">5.1</span> Bigblow</h3>
<div class="outline-text-3" id="text-5-1"> <div class="outline-text-3" id="text-5-1">
<p> <p>
In order to use the Bigblow style, just copy the <a href="setup/theme-bigblow.setup">theme-bigblow.setup</a> file to In order to use the Bigblow style, just copy the <a href="setup/theme-bigblow.setup">theme-bigblow.setup</a> file to
@ -435,9 +439,9 @@ your Org file instead:
</div> </div>
</div> </div>
<div id="outline-container-orgheadline12" class="outline-4"> <div id="outline-container-orgheadline11" class="outline-4">
<h4 id="orgheadline12">Local version</h4> <h4 id="orgheadline11">Local version</h4>
<div class="outline-text-4" id="text-orgheadline12"> <div class="outline-text-4" id="text-orgheadline11">
<p> <p>
Here a local version (using relative paths): Here a local version (using relative paths):
</p> </p>
@ -465,8 +469,8 @@ Here a local version (using relative paths):
</div> </div>
</div> </div>
<div id="outline-container-orgheadline14" class="outline-3"> <div id="outline-container-orgheadline13" class="outline-3">
<h3 id="orgheadline14"><span class="section-number-3">5.2</span> ReadTheOrg</h3> <h3 id="orgheadline13"><span class="section-number-3">5.2</span> ReadTheOrg</h3>
<div class="outline-text-3" id="text-5-2"> <div class="outline-text-3" id="text-5-2">
<p> <p>
In order to use the ReadTheOrg style, just copy the <a href="setup/theme-readtheorg.setup">theme-readtheorg.setup</a> file In order to use the ReadTheOrg style, just copy the <a href="setup/theme-readtheorg.setup">theme-readtheorg.setup</a> file
@ -504,8 +508,8 @@ your Org file instead:
<div id="outline-container-orgheadline19" class="outline-2"> <div id="outline-container-orgheadline19" class="outline-2">
<h2 id="orgheadline19"><span class="section-number-2">6</span> Contributing</h2> <h2 id="orgheadline19"><span class="section-number-2">6</span> Contributing</h2>
<div class="outline-text-2" id="text-6"> <div class="outline-text-2" id="text-6">
</div><div id="outline-container-orgheadline16" class="outline-3"> </div><div id="outline-container-orgheadline15" class="outline-3">
<h3 id="orgheadline16"><span class="section-number-3">6.1</span> Issues</h3> <h3 id="orgheadline15"><span class="section-number-3">6.1</span> Issues</h3>
<div class="outline-text-3" id="text-6-1"> <div class="outline-text-3" id="text-6-1">
<p> <p>
Report issues and suggest features and improvements on the <a href="https://github.com/fniessen/org-html-themes/issues/new">GitHub issue tracker</a>. Report issues and suggest features and improvements on the <a href="https://github.com/fniessen/org-html-themes/issues/new">GitHub issue tracker</a>.
@ -513,8 +517,8 @@ Report issues and suggest features and improvements on the <a href="https://gith
</div> </div>
</div> </div>
<div id="outline-container-orgheadline17" class="outline-3"> <div id="outline-container-orgheadline16" class="outline-3">
<h3 id="orgheadline17"><span class="section-number-3">6.2</span> Patches</h3> <h3 id="orgheadline16"><span class="section-number-3">6.2</span> Patches</h3>
<div class="outline-text-3" id="text-6-2"> <div class="outline-text-3" id="text-6-2">
<p> <p>
I love contributions! Patches under any form are always welcome! I love contributions! Patches under any form are always welcome!
@ -522,8 +526,8 @@ I love contributions! Patches under any form are always welcome!
</div> </div>
</div> </div>
<div id="outline-container-orgheadline18" class="outline-3"> <div id="outline-container-orgheadline17" class="outline-3">
<h3 id="orgheadline18"><span class="section-number-3">6.3</span> Donations</h3> <h3 id="orgheadline17"><span class="section-number-3">6.3</span> Donations</h3>
<div class="outline-text-3" id="text-6-3"> <div class="outline-text-3" id="text-6-3">
<p> <p>
If you like the org-html-themes project (or any of <a href="https://github.com/fniessen/">my other projects</a>), you can If you like the org-html-themes project (or any of <a href="https://github.com/fniessen/">my other projects</a>), you can
@ -537,6 +541,15 @@ beer and as in speech.
</p> </p>
</div> </div>
</div> </div>
<div id="outline-container-orgheadline18" class="outline-3">
<h3 id="orgheadline18"><span class="section-number-3">6.4</span> Follow me</h3>
<div class="outline-text-3" id="text-6-4">
<p>
I have an <a href="https://twitter.com/f_niessen">f_niessen</a> account on Twitter. You should follow it.
</p>
</div>
</div>
</div> </div>
<div id="outline-container-orgheadline20" class="outline-2"> <div id="outline-container-orgheadline20" class="outline-2">

19
README.org
View File

@ -23,18 +23,21 @@
** Description ** Description
Org mode provides basic HTML support. Though, we can easily override CSS Though you can easily override CSS stylesheets and add your own HTML themes, we
stylesheets and add our own HTML themes. can say (or write) that Org mode provides a /basic/ HTML support.
*Org-HMTL themes* is an open source framework for providing you with a list of
very nice (cross-browser) themes for all your Org documents. Use them, and your
colleagues will come up to tell you that you are a genius!
Share this content by tweeting this page:
#+begin_html #+begin_html
<script src="http://platform.twitter.com/widgets.js"></script> <script src="http://platform.twitter.com/widgets.js"></script>
<a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a> <a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a>
#+end_html #+end_html
** Objective Follow [[https://twitter.com/f_niessen][f_niessen]] on Twitter for updates on Org-HTML themes!
The goal of the *Org-HMTL themes* is to provide you with a list of very nice
(cross-browser) themes.
** Requirements ** Requirements
@ -272,6 +275,10 @@ a [[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&
Regardless of the donations, org-html-themes will always be free both as in Regardless of the donations, org-html-themes will always be free both as in
beer and as in speech. beer and as in speech.
** Follow me
I have an [[https://twitter.com/f_niessen][f_niessen]] account on Twitter. You should follow it.
* License * License
Copyright (C) 2011-2015 Fabrice Niessen. Copyright (C) 2011-2015 Fabrice Niessen.