Add section about the demo page (org-mode-syntax)

pull/11/head
Fabrice Niessen 2015-04-21 21:39:52 +02:00
parent 0bc0da2da1
commit e6e1856f13
2 changed files with 51 additions and 35 deletions

View File

@ -34,24 +34,25 @@
<li><a href="#orgheadline7">3.2. ReadTheOrg</a></li>
</ul>
</li>
<li><a href="#orgheadline12">4. Installing a theme</a>
<li><a href="#orgheadline9">4. Demo</a></li>
<li><a href="#orgheadline13">5. Installing a theme</a>
<ul>
<li><a href="#orgheadline10">4.1. Bigblow</a>
<li><a href="#orgheadline11">5.1. Bigblow</a>
<ul>
<li><a href="#orgheadline9">Local version</a></li>
<li><a href="#orgheadline10">Local version</a></li>
</ul>
</li>
<li><a href="#orgheadline11">4.2. ReadTheOrg</a></li>
<li><a href="#orgheadline12">5.2. ReadTheOrg</a></li>
</ul>
</li>
<li><a href="#orgheadline16">5. Contributing</a>
<li><a href="#orgheadline17">6. Contributing</a>
<ul>
<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>
<li><a href="#orgheadline14">6.1. Issues</a></li>
<li><a href="#orgheadline15">6.2. Patches</a></li>
<li><a href="#orgheadline16">6.3. Donations</a></li>
</ul>
</li>
<li><a href="#orgheadline17">6. License</a></li>
<li><a href="#orgheadline18">7. License</a></li>
</ul>
</div>
</div>
@ -183,9 +184,16 @@
</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 id="outline-container-orgheadline9" class="outline-2">
<h2 id="orgheadline9"><span class="section-number-2">4</span> Demo</h2>
<div class="outline-text-2" id="text-4">
<p>I've written a demo page for the themes that provides a maximal working support of Org mode syntax.</p>
<p>Please see the <a href="demo/org-mode-syntax.html">org-mode-syntax</a> page for full examples of headings, code, admonitions, footnotes, tables and other details.</p>
</div>
</div>
<div id="outline-container-orgheadline13" class="outline-2">
<h2 id="orgheadline13"><span class="section-number-2">5</span> Installing a theme</h2>
<div class="outline-text-2" id="text-5">
<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">
@ -206,9 +214,9 @@
</li>
</ul>
</div>
<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">
<div id="outline-container-orgheadline11" class="outline-3">
<h3 id="orgheadline11"><span class="section-number-3">5.1</span> Bigblow</h3>
<div class="outline-text-3" id="text-5-1">
<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">
@ -233,9 +241,9 @@
<span class="org-org-meta-line">#+HTML_HEAD: &lt;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>"&gt;&lt;/script&gt;</span>
</pre></div>
</div>
<div id="outline-container-orgheadline9" class="outline-4">
<h4 id="orgheadline9">Local version</h4>
<div class="outline-text-4" id="text-orgheadline9">
<div id="outline-container-orgheadline10" class="outline-4">
<h4 id="orgheadline10">Local version</h4>
<div class="outline-text-4" id="text-orgheadline10">
<p>Here a local version (using relative paths):</p>
<div class="org-src-container">
<pre class="src src-org">
@ -257,9 +265,9 @@
</div>
</div>
</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">
<div id="outline-container-orgheadline12" class="outline-3">
<h3 id="orgheadline12"><span class="section-number-3">5.2</span> ReadTheOrg</h3>
<div class="outline-text-3" id="text-5-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">
@ -279,32 +287,32 @@
</div>
</div>
</div>
<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-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">
<div id="outline-container-orgheadline17" class="outline-2">
<h2 id="orgheadline17"><span class="section-number-2">6</span> Contributing</h2>
<div class="outline-text-2" id="text-6"></div>
<div id="outline-container-orgheadline14" class="outline-3">
<h3 id="orgheadline14"><span class="section-number-3">6.1</span> Issues</h3>
<div class="outline-text-3" id="text-6-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-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">
<div id="outline-container-orgheadline15" class="outline-3">
<h3 id="orgheadline15"><span class="section-number-3">6.2</span> Patches</h3>
<div class="outline-text-3" id="text-6-2">
<p>I love contributions! Patches under any form are always welcome!</p>
</div>
</div>
<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">
<div id="outline-container-orgheadline16" class="outline-3">
<h3 id="orgheadline16"><span class="section-number-3">6.3</span> Donations</h3>
<div class="outline-text-3" id="text-6-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&amp;business=VCVAS6KPDQ4JC&amp;lc=BE&amp;item_number=org-html-themes&amp;currency_code=EUR&amp;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-orgheadline17" class="outline-2">
<h2 id="orgheadline17"><span class="section-number-2">6</span> License</h2>
<div class="outline-text-2" id="text-6">
<div id="outline-container-orgheadline18" class="outline-2">
<h2 id="orgheadline18"><span class="section-number-2">7</span> License</h2>
<div class="outline-text-2" id="text-7">
<p>Copyright (C) 2011-2015 Fabrice Niessen.</p>
<p>Author: Fabrice Niessen<br />
Keywords: org-mode html themes</p>

View File

@ -108,6 +108,14 @@ responsibilities. Help is welcome to work on that (and eventually improve the
default structure of the HTML export)!
#+end_note
* Demo
I've written a demo page for the themes that provides a maximal working support
of Org mode syntax.
Please see the [[file:demo/org-mode-syntax.org][org-mode-syntax]] page for full examples of headings, code,
admonitions, footnotes, tables and other details.
* Installing a theme
Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy: