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

Add usage of the HTTPS URL to the SETUPFILE

This commit is contained in:
Fabrice Niessen 2018-11-29 21:12:53 +01:00
parent 713e977c18
commit c504da9a14
3 changed files with 163 additions and 268 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

250
README.html
View File

@ -196,44 +196,35 @@
<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="#orgefa6037">1. Overview</a> <li><a href="#orgb7bb81e">1. Overview</a>
<ul> <ul>
<li><a href="#org33e33d2">1.1. Description</a></li> <li><a href="#orgf93996a">1.1. Description</a></li>
<li><a href="#org4cf306f">1.2. Requirements</a></li> <li><a href="#orge06470b">1.2. Requirements</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org3c57e36">2. Quotations</a> <li><a href="#org21286cc">2. Quotations</a>
<ul> <ul>
<li><a href="#org2400804">2.1. About Bigblow</a></li> <li><a href="#orgcee920d">2.1. About Bigblow</a></li>
<li><a href="#orgb712dbf">2.2. About ReadTheOrg</a></li> <li><a href="#orgab904f8">2.2. About ReadTheOrg</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orga25c659">3. Gallery</a> <li><a href="#org7a909af">3. Gallery</a>
<ul> <ul>
<li><a href="#org674fe96">3.1. Bigblow</a></li> <li><a href="#org9b643d4">3.1. Bigblow</a></li>
<li><a href="#org314f86f">3.2. ReadTheOrg</a></li> <li><a href="#orga67d910">3.2. ReadTheOrg</a></li>
</ul> </ul>
</li> </li>
<li><a href="#orgd0c355f">4. Demo</a></li> <li><a href="#org4c98e3d">4. Demo</a></li>
<li><a href="#org09ccc5d">5. Installing a theme</a> <li><a href="#orgad9193b">5. Using a theme</a></li>
<li><a href="#orgbf8f2d6">6. Contributing</a>
<ul> <ul>
<li><a href="#org5c46bbe">5.1. Bigblow</a> <li><a href="#org1aaf508">6.1. Issues</a></li>
<ul> <li><a href="#org2dfcfcb">6.2. Patches</a></li>
<li><a href="#org9ac9015">Local version</a></li> <li><a href="#org2f086bf">6.3. Donations</a></li>
<li><a href="#orgdf21acb">6.4. Follow me</a></li>
</ul> </ul>
</li> </li>
<li><a href="#org634efa3">5.2. ReadTheOrg</a></li> <li><a href="#org732cd65">7. License</a></li>
</ul>
</li>
<li><a href="#org8ff2acc">6. Contributing</a>
<ul>
<li><a href="#orgeb8fe32">6.1. Issues</a></li>
<li><a href="#org3d30a1d">6.2. Patches</a></li>
<li><a href="#orgfcbcf79">6.3. Donations</a></li>
<li><a href="#org4c95a4a">6.4. Follow me</a></li>
</ul>
</li>
<li><a href="#orgbe4464c">7. License</a></li>
</ul> </ul>
</div> </div>
</div> </div>
@ -244,12 +235,12 @@
<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-orgefa6037" class="outline-2"> <div id="outline-container-orgb7bb81e" class="outline-2">
<h2 id="orgefa6037"><span class="section-number-2">1</span> Overview</h2> <h2 id="orgb7bb81e"><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>
<div id="outline-container-org33e33d2" class="outline-3"> <div id="outline-container-orgf93996a" class="outline-3">
<h3 id="org33e33d2"><span class="section-number-3">1.1</span> Description</h3> <h3 id="orgf93996a"><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>
Though you can easily override CSS stylesheets and add your own HTML themes, we Though you can easily override CSS stylesheets and add your own HTML themes, we
@ -275,8 +266,8 @@ Follow <a href="https://twitter.com/f_niessen">f_niessen</a> on Twitter for upda
</div> </div>
</div> </div>
<div id="outline-container-org4cf306f" class="outline-3"> <div id="outline-container-orge06470b" class="outline-3">
<h3 id="org4cf306f"><span class="section-number-3">1.2</span> Requirements</h3> <h3 id="orge06470b"><span class="section-number-3">1.2</span> Requirements</h3>
<div class="outline-text-3" id="text-1-2"> <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.
@ -289,12 +280,12 @@ If such a version is not bundled with your Emacs, install one from ELPA.
</div> </div>
</div> </div>
<div id="outline-container-org3c57e36" class="outline-2"> <div id="outline-container-org21286cc" class="outline-2">
<h2 id="org3c57e36"><span class="section-number-2">2</span> Quotations</h2> <h2 id="org21286cc"><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>
<div id="outline-container-org2400804" class="outline-3"> <div id="outline-container-orgcee920d" class="outline-3">
<h3 id="org2400804"><span class="section-number-3">2.1</span> About Bigblow</h3> <h3 id="orgcee920d"><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 />
@ -335,8 +326,8 @@ wonderful package!&rdquo; <br />
</div> </div>
</div> </div>
<div id="outline-container-orgb712dbf" class="outline-3"> <div id="outline-container-orgab904f8" class="outline-3">
<h3 id="orgb712dbf"><span class="section-number-3">2.2</span> About ReadTheOrg</h3> <h3 id="orgab904f8"><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
@ -376,8 +367,8 @@ available.&rdquo; <br />
</div> </div>
</div> </div>
<div id="outline-container-orga25c659" class="outline-2"> <div id="outline-container-org7a909af" class="outline-2">
<h2 id="orga25c659"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class="section-number-2">3</span> Gallery</h2> <h2 id="org7a909af"><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
@ -385,8 +376,8 @@ now! Well, I hope to have more than one in a couple of weeks&#x2026;
</p> </p>
</div> </div>
<div id="outline-container-org674fe96" class="outline-3"> <div id="outline-container-org9b643d4" class="outline-3">
<h3 id="org674fe96"><span class="section-number-3">3.1</span> Bigblow</h3> <h3 id="org9b643d4"><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
@ -486,8 +477,8 @@ Keyboard shortcuts to save time and boost your productivity:
</div> </div>
</div> </div>
<div id="outline-container-org314f86f" class="outline-3"> <div id="outline-container-orga67d910" class="outline-3">
<h3 id="org314f86f"><span class="section-number-3">3.2</span> ReadTheOrg</h3> <h3 id="orga67d910"><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; <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> ReadTheOrg is a clone of the official &#x2013; and great! &#x2013; <a href="https://github.com/snide/sphinx_rtd_theme">theme</a>
@ -522,8 +513,8 @@ default structure of the HTML export)!
</div> </div>
</div> </div>
<div id="outline-container-orgd0c355f" class="outline-2"> <div id="outline-container-org4c98e3d" class="outline-2">
<h2 id="orgd0c355f"><span class="section-number-2">4</span> Demo</h2> <h2 id="org4c98e3d"><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
@ -537,158 +528,55 @@ admonitions, footnotes, tables and other details.
</div> </div>
</div> </div>
<div id="outline-container-org09ccc5d" class="outline-2"> <div id="outline-container-orgad9193b" class="outline-2">
<h2 id="org09ccc5d"><span class="section-number-2">5</span> Installing a theme</h2> <h2 id="orgad9193b"><span class="section-number-2">5</span> Using 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="#orga25c659">theme gallery</a> for your own Org documents is very easy: Using a theme from the <a href="#org7a909af">theme gallery</a> for your own Org documents is very easy:
you just need to <b>clone or download</b> the Org-HTML themes project, add </p>
a <code>#+SETUPFILE:</code> directive in the preamble to include the CSS and JavaScript
files, then export your Org mode file to HTML. <ol class="org-ol">
<li><p>
You <b>add a <code>#+SETUPFILE:</code> directive</b> in the preamble of your document (to include
the necessary CSS and JavaScript files).
</p> </p>
<p> <p>
You can either: You can either use an URL of the following type for the &ldquo;setup file&rdquo; of your
</p> chosen theme:
<ul class="org-ul">
<li><p>
copy the &ldquo;setup file&rdquo; of the chosen theme to the directory of your Org files,
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line"> #+SETUPFILE: THEME-NAME.setup</span> <pre class="src src-org"><span class="org-org-meta-line"> #+SETUPFILE: <a href="https://fniessen.github.io/org-html-themes/setup/THEME-NAME.setup">https://fniessen.github.io/org-html-themes/setup/THEME-NAME.setup</a></span>
</pre> </pre>
</div> </div>
<p> <p>
or (where <code>THEME-NAME</code> is <code>theme-bigblow</code> or <code>theme-readtheorg</code>)
</p></li> </p>
<li><p> <p>
use the (relative or absolute) path to the &ldquo;setup file&rdquo; (in your Git local or, if you <b>cloned or downloaded</b> the Org-HTML themes project, use a (relative
repository) or absolute) path to the &ldquo;setup file&rdquo;:
</p> </p>
<div class="org-src-container"> <div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line"> #+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup</span> <pre class="src src-org"><span class="org-org-meta-line"> #+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup</span>
</pre> </pre>
</div></li> </div></li>
</ul>
<p> <li>Then, you <b>export</b> your Org mode file <b>to HTML</b> with <code>org-html-export-to-html</code> or
Then export your Org mode file to HTML with <code>org-html-export-to-html</code> or with <code>C-c with <code>C-c C-e h h</code>.</li>
C-e h h</code>. </ol>
</p>
</div>
<div id="outline-container-org5c46bbe" class="outline-3">
<h3 id="org5c46bbe"><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"><span class="org-org-meta-line">#+SETUPFILE: theme-bigblow.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: &lt;link rel="stylesheet" type="text/css" href="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/htmlize.css&quot;/">https://fniessen.github.io/org-html-themes/styles/bigblow/css/htmlize.css"/</a>&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;link rel="stylesheet" type="text/css" href="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/bigblow.css&quot;/">https://fniessen.github.io/org-html-themes/styles/bigblow/css/bigblow.css"/</a>&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;link rel="stylesheet" type="text/css" href="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/hideshow.css&quot;/">https://fniessen.github.io/org-html-themes/styles/bigblow/css/hideshow.css"/</a>&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-1.11.0.min.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-1.11.0.min.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-ui-1.10.2.min.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.localscroll-min.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.localscroll-min.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.zclip.min.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.zclip.min.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/bigblow.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/bigblow.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/bigblow/js/hideshow.js">https://fniessen.github.io/org-html-themes/styles/bigblow/js/hideshow.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js">https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js</a>"&gt;&lt;/script&gt;</span>
</pre>
</div> </div>
</div> </div>
<div id="outline-container-org9ac9015" class="outline-4"> <div id="outline-container-orgbf8f2d6" class="outline-2">
<h4 id="org9ac9015">Local version</h4> <h2 id="orgbf8f2d6"><span class="section-number-2">6</span> Contributing</h2>
<div class="outline-text-4" id="text-org9ac9015">
<p>
Here a local version (using relative paths):
</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: &lt;link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/bigblow.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/bigblow/js/hideshow.js"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="styles/lib/js/jquery.stickytableheaders.min.js"&gt;&lt;/script&gt;</span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org634efa3" class="outline-3">
<h3 id="org634efa3"><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"><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: &lt;link rel="stylesheet" type="text/css" href="<a href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/htmlize.css&quot;/">https://fniessen.github.io/org-html-themes/styles/readtheorg/css/htmlize.css"/</a>&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;link rel="stylesheet" type="text/css" href="<a href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/readtheorg.css&quot;/">https://fniessen.github.io/org-html-themes/styles/readtheorg/css/readtheorg.css"/</a>&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;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>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;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>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js">https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js</a>"&gt;&lt;/script&gt;</span>
<span class="org-org-meta-line">#+HTML_HEAD: &lt;script type="text/javascript" src="<a href="https://fniessen.github.io/org-html-themes/styles/readtheorg/js/readtheorg.js">https://fniessen.github.io/org-html-themes/styles/readtheorg/js/readtheorg.js</a>"&gt;&lt;/script&gt;</span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-org8ff2acc" class="outline-2">
<h2 id="org8ff2acc"><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>
<div id="outline-container-orgeb8fe32" class="outline-3"> <div id="outline-container-org1aaf508" class="outline-3">
<h3 id="orgeb8fe32"><span class="section-number-3">6.1</span> Issues</h3> <h3 id="org1aaf508"><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>.
@ -696,8 +584,8 @@ Report issues and suggest features and improvements on the <a href="https://gith
</div> </div>
</div> </div>
<div id="outline-container-org3d30a1d" class="outline-3"> <div id="outline-container-org2dfcfcb" class="outline-3">
<h3 id="org3d30a1d"><span class="section-number-3">6.2</span> Patches</h3> <h3 id="org2dfcfcb"><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!
@ -705,8 +593,8 @@ I love contributions! Patches under any form are always welcome!
</div> </div>
</div> </div>
<div id="outline-container-orgfcbcf79" class="outline-3"> <div id="outline-container-org2f086bf" class="outline-3">
<h3 id="orgfcbcf79"><span class="section-number-3">6.3</span> Donations</h3> <h3 id="org2f086bf"><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 use the org-html-themes project (or any of <a href="https://github.com/fniessen/">my other projects</a>) and feel it If you use the org-html-themes project (or any of <a href="https://github.com/fniessen/">my other projects</a>) and feel it
@ -722,8 +610,8 @@ beer and as in speech.
</div> </div>
</div> </div>
<div id="outline-container-org4c95a4a" class="outline-3"> <div id="outline-container-orgdf21acb" class="outline-3">
<h3 id="org4c95a4a"><span class="section-number-3">6.4</span> Follow me</h3> <h3 id="orgdf21acb"><span class="section-number-3">6.4</span> Follow me</h3>
<div class="outline-text-3" id="text-6-4"> <div class="outline-text-3" id="text-6-4">
<p> <p>
I have an <a href="https://twitter.com/f_niessen">f_niessen</a> account on Twitter. You should follow it. I have an <a href="https://twitter.com/f_niessen">f_niessen</a> account on Twitter. You should follow it.
@ -732,8 +620,8 @@ I have an <a href="https://twitter.com/f_niessen">f_niessen</a> account on Twitt
</div> </div>
</div> </div>
<div id="outline-container-orgbe4464c" class="outline-2"> <div id="outline-container-org732cd65" class="outline-2">
<h2 id="orgbe4464c"><span class="section-number-2">7</span> License</h2> <h2 id="org732cd65"><span class="section-number-2">7</span> License</h2>
<div class="outline-text-2" id="text-7"> <div class="outline-text-2" id="text-7">
<p> <p>
Copyright (C) 2011-2017 Fabrice Niessen. Copyright (C) 2011-2017 Fabrice Niessen.

181
README.org
View File

@ -165,108 +165,115 @@ of Org mode syntax.
Please see the [[https://github.com/fniessen/refcard-org-mode][Org mode refcard]] page for full examples of headings, code, Please see the [[https://github.com/fniessen/refcard-org-mode][Org mode refcard]] page for full examples of headings, code,
admonitions, footnotes, tables and other details. admonitions, footnotes, tables and other details.
* Installing a theme * Using a theme
Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy: Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy:
you just need to *clone or download* the Org-HTML themes project, add
a =#+SETUPFILE:= directive in the preamble to include the CSS and JavaScript
files, then export your Org mode file to HTML.
You can either: 1. You *add a =#+SETUPFILE:= directive* in the preamble of your document (to include
the necessary CSS and JavaScript files).
- copy the "setup file" of the chosen theme to the directory of your Org files, You can either use an URL of the following type for the "setup file" of your
chosen theme:
#+begin_src org :exports code #+begin_src org :exports code
,#+SETUPFILE: THEME-NAME.setup ,#+SETUPFILE: https://fniessen.github.io/org-html-themes/setup/THEME-NAME.setup
#+end_src #+end_src
or (where ~THEME-NAME~ is ~theme-bigblow~ or ~theme-readtheorg~)
- use the (relative or absolute) path to the "setup file" (in your Git local or, if you *cloned or downloaded* the Org-HTML themes project, use a (relative
repository) or absolute) path to the "setup file":
#+begin_src org :exports code #+begin_src org :exports code
,#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup ,#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup
#+end_src #+end_src
Then export your Org mode file to HTML with =org-html-export-to-html= or with =C-c 2. Then, you *export* your Org mode file *to HTML* with =org-html-export-to-html= or
C-e h h=. with =C-c C-e h h=.
** Bigblow # ** Bigblow :noexport:
#
In order to use the Bigblow style, just copy the [[file:setup/theme-bigblow.setup][theme-bigblow.setup]] file to # 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: # your project and link to it this way:
#
#+begin_src org :exports code # #+begin_src org :exports code
,#+SETUPFILE: theme-bigblow.setup # ,#+SETUPFILE: theme-bigblow.setup
#+end_src # #+end_src
#
If you prefer, you can add the content of the setup file at the beginning of # If you prefer, you can add the content of the setup file at the beginning of
your Org file instead: # your Org file instead:
#
#+begin_src org :exports code :tangle setup/theme-bigblow.setup # #+begin_src org :exports code :tangle setup/theme-bigblow.setup
# -*- mode: org; -*- # # -*- mode: org; -*-
#
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/htmlize.css"/> # ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/htmlize.css"/>
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/bigblow.css"/> # ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/bigblow.css"/>
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/hideshow.css"/> # ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/hideshow.css"/>
#
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-1.11.0.min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-1.11.0.min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
#
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.localscroll-min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.localscroll-min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.zclip.min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.zclip.min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/bigblow.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/bigblow.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/hideshow.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/hideshow.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script>
#+end_src # #+end_src
#
*** Local version # #+begin_src org :exports code :tangle setup/theme-bigblow-local.setup
# # -*- mode: org; -*-
Here a local version (using relative paths): #
# ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/>
#+begin_src org :exports code :tangle setup/theme-bigblow-local.setup # ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/>
# -*- mode: org; -*- # ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/>
#
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/> # ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script>
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/> # ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/> #
# ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"></script>
# ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/bigblow.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script> # ,#+HTML_HEAD: <script type="text/javascript" src="styles/lib/js/jquery.stickytableheaders.min.js"></script>
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"></script> # #+end_src
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/bigblow.js"></script> #
,#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script> # ** Readtheorg :noexport:
,#+HTML_HEAD: <script type="text/javascript" src="styles/lib/js/jquery.stickytableheaders.min.js"></script> #
#+end_src # 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:
** ReadTheOrg #
# #+begin_src org :exports code
In order to use the ReadTheOrg style, just copy the [[file:setup/theme-readtheorg.setup][theme-readtheorg.setup]] file # ,#+SETUPFILE: theme-readtheorg.setup
to your project and link to it this way: # #+end_src
#
#+begin_src org :exports code # If you prefer, you can add the content of the setup file at the beginning of
,#+SETUPFILE: theme-readtheorg.setup # your Org file instead:
#+end_src #
# #+begin_src org :exports code :tangle setup/theme-readtheorg.setup
If you prefer, you can add the content of the setup file at the beginning of # # -*- mode: org; -*-
your Org file instead: #
# ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/htmlize.css"/>
#+begin_src org :exports code :tangle setup/theme-readtheorg.setup # ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/readtheorg.css"/>
# -*- mode: org; -*- #
# ,#+HTML_HEAD: <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/htmlize.css"/> # ,#+HTML_HEAD: <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/readtheorg.css"/> # ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script>
# ,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/readtheorg/js/readtheorg.js"></script>
,#+HTML_HEAD: <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script> # #+end_src
,#+HTML_HEAD: <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> #
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script> # #+begin_src org :exports code :tangle setup/theme-readtheorg-local.setup
,#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/readtheorg/js/readtheorg.js"></script> # # -*- mode: org; -*-
#+end_src #
# ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/readtheorg/css/htmlize.css"/>
# ,#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/readtheorg/css/readtheorg.css"/>
#
# ,#+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="styles/lib/js/jquery.stickytableheaders.min.js"></script>
# ,#+HTML_HEAD: <script type="text/javascript" src="styles/readtheorg/js/readtheorg.js"></script>
# #+end_src
* Contributing * Contributing

0
setup/theme-readtheorg-local.setup Executable file → Normal file
View File