Add sections about ReadTheOrg
Fabrice Niessen
parent
5acccd37b8
commit
c83c5638df
97
README.html
97
README.html
|
|
@ -28,29 +28,30 @@
|
|||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgheadline5">2. Quotations</a></li>
|
||||
<li><a href="#orgheadline7">3. Gallery</a>
|
||||
<li><a href="#orgheadline8">3. Gallery</a>
|
||||
<ul>
|
||||
<li><a href="#orgheadline6">3.1. Bigblow</a></li>
|
||||
<li><a href="#orgheadline7">3.2. ReadTheOrg</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgheadline11">4. Installing a theme</a>
|
||||
<li><a href="#orgheadline12">4. Installing a theme</a>
|
||||
<ul>
|
||||
<li><a href="#orgheadline10">4.1. Bigblow</a>
|
||||
<ul>
|
||||
<li><a href="#orgheadline8">Local version</a></li>
|
||||
<li><a href="#orgheadline9">Development version</a></li>
|
||||
<li><a href="#orgheadline9">Local version</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgheadline11">4.2. ReadTheOrg</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgheadline15">5. Contributing</a>
|
||||
<li><a href="#orgheadline16">5. Contributing</a>
|
||||
<ul>
|
||||
<li><a href="#orgheadline12">5.1. Issues</a></li>
|
||||
<li><a href="#orgheadline13">5.2. Patches</a></li>
|
||||
<li><a href="#orgheadline14">5.3. Donations</a></li>
|
||||
<li><a href="#orgheadline13">5.1. Issues</a></li>
|
||||
<li><a href="#orgheadline14">5.2. Patches</a></li>
|
||||
<li><a href="#orgheadline15">5.3. Donations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#orgheadline16">6. License</a></li>
|
||||
<li><a href="#orgheadline17">6. License</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -94,8 +95,8 @@
|
|||
- <i>Shankar R.</i></p>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline7" class="outline-2">
|
||||
<h2 id="orgheadline7"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4" name="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class="section-number-2">3</span> Gallery</h2>
|
||||
<div id="outline-container-orgheadline8" class="outline-2">
|
||||
<h2 id="orgheadline8"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4" name="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class="section-number-2">3</span> Gallery</h2>
|
||||
<div class="outline-text-2" id="text-3">
|
||||
<p>This is a list of available <b>HTML themes for Org mode</b>, which you can use right now! Well, I hope to have more than one in a couple of weeks…</p>
|
||||
</div>
|
||||
|
|
@ -171,11 +172,21 @@
|
|||
</table>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline7" class="outline-3">
|
||||
<h3 id="orgheadline7"><span class="section-number-3">3.2</span> ReadTheOrg</h3>
|
||||
<div class="outline-text-3" id="text-3-2">
|
||||
<p>ReadTheOrg is a clone of the official - and great! - theme (called <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx</a>) used in the <a href="http://docs.readthedocs.org/en/latest/">Read The Docs</a> site. It gives a beautiful and professional style to all your Org docs.</p>
|
||||
<div class="note">
|
||||
<p>While the original theme shines on mobile devices as well, ReadTheOrg does not stay completely functional.</p>
|
||||
<p>I don't have a lot of time to maintain this project due to other responsibilities. Help is welcome to work on that (and eventually improve the default structure of the HTML export)!</p>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline11" class="outline-2">
|
||||
<h2 id="orgheadline11"><span class="section-number-2">4</span> Installing a theme</h2>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline12" class="outline-2">
|
||||
<h2 id="orgheadline12"><span class="section-number-2">4</span> Installing a theme</h2>
|
||||
<div class="outline-text-2" id="text-4">
|
||||
<p>Using a theme from the <a href="#orgheadline7">theme gallery</a> for your own Org documents is very easy: you just need to clone the Org-HTML themes project and add a <code>#+SETUPFILE:</code> directive in the preamble to include the CSS and JavaScript files.</p>
|
||||
<p>Using a theme from the <a href="#orgheadline8">theme gallery</a> for your own Org documents is very easy: you just need to clone the Org-HTML themes project and add a <code>#+SETUPFILE:</code> directive in the preamble to include the CSS and JavaScript files.</p>
|
||||
<p>You can either:</p>
|
||||
<ul class="org-ul">
|
||||
<li>
|
||||
|
|
@ -198,7 +209,7 @@
|
|||
<div id="outline-container-orgheadline10" class="outline-3">
|
||||
<h3 id="orgheadline10"><span class="section-number-3">4.1</span> Bigblow</h3>
|
||||
<div class="outline-text-3" id="text-4-1">
|
||||
<p>In order to use this style, just copy the <a href="setup/theme-bigblow.setup">theme-bigblow.setup</a> file to your project and link to it this way:</p>
|
||||
<p>In order to use the Bigblow style, just copy the <a href="setup/theme-bigblow.setup">theme-bigblow.setup</a> file to your project and link to it this way:</p>
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-org-meta-line">#+SETUPFILE: theme-bigblow.setup</span>
|
||||
|
|
@ -222,9 +233,9 @@
|
|||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/hideshow.js">http://www.pirilampo.org/styles/bigblow/js/hideshow.js</a>"></script></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline8" class="outline-4">
|
||||
<h4 id="orgheadline8">Local version</h4>
|
||||
<div class="outline-text-4" id="text-orgheadline8">
|
||||
<div id="outline-container-orgheadline9" class="outline-4">
|
||||
<h4 id="orgheadline9">Local version</h4>
|
||||
<div class="outline-text-4" id="text-orgheadline9">
|
||||
<p>Here a local version (using relative paths):</p>
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
|
|
@ -245,56 +256,54 @@
|
|||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline9" class="outline-4">
|
||||
<h4 id="orgheadline9">Development version</h4>
|
||||
<div class="outline-text-4" id="text-orgheadline9">
|
||||
<p>Here is a remote version (with CSS/JS files served from GitHub webservers) to share <b>temporary</b> examples or demos with small numbers of people:</p>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline11" class="outline-3">
|
||||
<h3 id="orgheadline11"><span class="section-number-3">4.2</span> ReadTheOrg</h3>
|
||||
<div class="outline-text-3" id="text-4-2">
|
||||
<p>In order to use the ReadTheOrg style, just copy the <a href="setup/theme-readtheorg.setup">theme-readtheorg.setup</a> file to your project and link to it this way:</p>
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-org-meta-line">#+SETUPFILE: theme-readtheorg.setup</span>
|
||||
</pre></div>
|
||||
<p>If you prefer, you can add the content of the setup file at the beginning of your Org file instead:</p>
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-comment"># -*- mode: org; -*-</span>
|
||||
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/readtheorg/css/readtheorg.css"/">http://www.pirilampo.org/styles/readtheorg/css/readtheorg.css"/</a>></span>
|
||||
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"></script></span>
|
||||
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script src="<a href="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js">https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script src="<a href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js">https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/readtheorg/js/readtheorg.js">http://www.pirilampo.org/styles/readtheorg/js/readtheorg.js</a>"></script></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline15" class="outline-2">
|
||||
<h2 id="orgheadline15"><span class="section-number-2">5</span> Contributing</h2>
|
||||
<div id="outline-container-orgheadline16" class="outline-2">
|
||||
<h2 id="orgheadline16"><span class="section-number-2">5</span> Contributing</h2>
|
||||
<div class="outline-text-2" id="text-5"></div>
|
||||
<div id="outline-container-orgheadline12" class="outline-3">
|
||||
<h3 id="orgheadline12"><span class="section-number-3">5.1</span> Issues</h3>
|
||||
<div id="outline-container-orgheadline13" class="outline-3">
|
||||
<h3 id="orgheadline13"><span class="section-number-3">5.1</span> Issues</h3>
|
||||
<div class="outline-text-3" id="text-5-1">
|
||||
<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>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline13" class="outline-3">
|
||||
<h3 id="orgheadline13"><span class="section-number-3">5.2</span> Patches</h3>
|
||||
<div id="outline-container-orgheadline14" class="outline-3">
|
||||
<h3 id="orgheadline14"><span class="section-number-3">5.2</span> Patches</h3>
|
||||
<div class="outline-text-3" id="text-5-2">
|
||||
<p>I love contributions! Patches under any form are always welcome!</p>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline14" class="outline-3">
|
||||
<h3 id="orgheadline14"><span class="section-number-3">5.3</span> Donations</h3>
|
||||
<div id="outline-container-orgheadline15" class="outline-3">
|
||||
<h3 id="orgheadline15"><span class="section-number-3">5.3</span> Donations</h3>
|
||||
<div class="outline-text-3" id="text-5-3">
|
||||
<p>If you like the org-html-themes project, you can show your appreciation and support future development by making a <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org-html-themes&currency_code=EUR&bn=PP-DonationsBF:btn_donate_LG.gif:NonHosted">donation</a> through PayPal.</p>
|
||||
<p>Regardless of the donations, org-html-themes will always be free both as in beer and as in speech.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="outline-container-orgheadline16" class="outline-2">
|
||||
<h2 id="orgheadline16"><span class="section-number-2">6</span> License</h2>
|
||||
<div id="outline-container-orgheadline17" class="outline-2">
|
||||
<h2 id="orgheadline17"><span class="section-number-2">6</span> License</h2>
|
||||
<div class="outline-text-2" id="text-6">
|
||||
<p>Copyright (C) 2011-2015 Fabrice Niessen.</p>
|
||||
<p>Author: Fabrice Niessen<br />
|
||||
|
|
|
|||
49
README.org
49
README.org
|
|
@ -93,6 +93,21 @@ Keyboard shortcuts to save time and boost your productivity:
|
|||
| =q= | Stop reviewing the list of tasks |
|
||||
| =g= | Reload the page |
|
||||
|
||||
** ReadTheOrg
|
||||
|
||||
ReadTheOrg is a clone of the official -- and great! -- theme (called [[https://github.com/snide/sphinx_rtd_theme][Sphinx]])
|
||||
used in the [[http://docs.readthedocs.org/en/latest/][Read The Docs]] site. It gives a beautiful and professional style to
|
||||
all your Org docs.
|
||||
|
||||
#+begin_note
|
||||
While the original theme shines on mobile devices as well, ReadTheOrg does not
|
||||
stay completely functional.
|
||||
|
||||
I don't have a lot of time to maintain this project due to other
|
||||
responsibilities. Help is welcome to work on that (and eventually improve the
|
||||
default structure of the HTML export)!
|
||||
#+end_note
|
||||
|
||||
* Installing a theme
|
||||
|
||||
Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy:
|
||||
|
|
@ -118,8 +133,8 @@ You can either:
|
|||
|
||||
** Bigblow
|
||||
|
||||
In order to use this style, just copy the [[file:setup/theme-bigblow.setup][theme-bigblow.setup]] file to your
|
||||
project and link to it this way:
|
||||
In order to use the Bigblow style, just copy the [[file:setup/theme-bigblow.setup][theme-bigblow.setup]] file to
|
||||
your project and link to it this way:
|
||||
|
||||
#+begin_src org :exports code
|
||||
,#+SETUPFILE: theme-bigblow.setup
|
||||
|
|
@ -166,26 +181,26 @@ Here a local version (using relative paths):
|
|||
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script>
|
||||
#+end_src
|
||||
|
||||
*** Development version
|
||||
** ReadTheOrg
|
||||
|
||||
Here is a remote version (with CSS/JS files served from GitHub webservers) to
|
||||
share *temporary* examples or demos with small numbers of people:
|
||||
In order to use the ReadTheOrg style, just copy the [[file:setup/theme-readtheorg.setup][theme-readtheorg.setup]] file
|
||||
to your project and link to it this way:
|
||||
|
||||
#+begin_src org :exports code :tangle setup/theme-bigblow-github-dev.setup
|
||||
#+begin_src org :exports code
|
||||
,#+SETUPFILE: theme-readtheorg.setup
|
||||
#+end_src
|
||||
|
||||
If you prefer, you can add the content of the setup file at the beginning of
|
||||
your Org file instead:
|
||||
|
||||
#+begin_src org :exports code :tangle setup/theme-readtheorg.setup
|
||||
# -*- mode: org; -*-
|
||||
|
||||
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/>
|
||||
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/>
|
||||
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/>
|
||||
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/readtheorg/css/readtheorg.css"/>
|
||||
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js"></script>
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
|
||||
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js"></script>
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js"></script>
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js"></script>
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js"></script>
|
||||
,#+HTML_HEAD: <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
|
||||
,#+HTML_HEAD: <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
|
||||
,#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/readtheorg/js/readtheorg.js"></script>
|
||||
#+end_src
|
||||
|
||||
* Contributing
|
||||
|
|
|
|||
Loading…
Reference in New Issue