-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
832 lines (740 loc) · 31.6 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2018-11-17 Sat 15:53 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>How to export Org mode files into awesome HTML in 2 minutes</title>
<meta name="generator" content="Org mode" />
<meta name="author" content="Fabrice Niessen" />
<meta name="description" content="Org-HTML export made simple."
/>
<meta name="keywords" content="org-mode, export, html, theme, style, css, js, bigblow" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
pre {
border: 1px solid #ccc;
box-shadow: 3px 3px 3px #eee;
padding: 8pt;
font-family: monospace;
overflow: auto;
margin: 1.2em;
}
pre.src {
position: relative;
overflow: visible;
padding-top: 1.2em;
}
pre.src:before {
display: none;
position: absolute;
background-color: white;
top: -10px;
right: 40px;
padding: 3px;
border: 1px solid black;
}
pre.src:hover:before { display: inline;}
/* Languages per Org manual */
pre.src-asymptote:before { content: 'Asymptote'; }
pre.src-awk:before { content: 'Awk'; }
pre.src-C:before { content: 'C'; }
/* pre.src-C++ doesn't work in CSS */
pre.src-clojure:before { content: 'Clojure'; }
pre.src-css:before { content: 'CSS'; }
pre.src-D:before { content: 'D'; }
pre.src-ditaa:before { content: 'ditaa'; }
pre.src-dot:before { content: 'Graphviz'; }
pre.src-calc:before { content: 'Emacs Calc'; }
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
pre.src-fortran:before { content: 'Fortran'; }
pre.src-gnuplot:before { content: 'gnuplot'; }
pre.src-haskell:before { content: 'Haskell'; }
pre.src-hledger:before { content: 'hledger'; }
pre.src-java:before { content: 'Java'; }
pre.src-js:before { content: 'Javascript'; }
pre.src-latex:before { content: 'LaTeX'; }
pre.src-ledger:before { content: 'Ledger'; }
pre.src-lisp:before { content: 'Lisp'; }
pre.src-lilypond:before { content: 'Lilypond'; }
pre.src-lua:before { content: 'Lua'; }
pre.src-matlab:before { content: 'MATLAB'; }
pre.src-mscgen:before { content: 'Mscgen'; }
pre.src-ocaml:before { content: 'Objective Caml'; }
pre.src-octave:before { content: 'Octave'; }
pre.src-org:before { content: 'Org mode'; }
pre.src-oz:before { content: 'OZ'; }
pre.src-plantuml:before { content: 'Plantuml'; }
pre.src-processing:before { content: 'Processing.js'; }
pre.src-python:before { content: 'Python'; }
pre.src-R:before { content: 'R'; }
pre.src-ruby:before { content: 'Ruby'; }
pre.src-sass:before { content: 'Sass'; }
pre.src-scheme:before { content: 'Scheme'; }
pre.src-screen:before { content: 'Gnu Screen'; }
pre.src-sed:before { content: 'Sed'; }
pre.src-sh:before { content: 'shell'; }
pre.src-sql:before { content: 'SQL'; }
pre.src-sqlite:before { content: 'SQLite'; }
/* additional languages in org.el's org-babel-load-languages alist */
pre.src-forth:before { content: 'Forth'; }
pre.src-io:before { content: 'IO'; }
pre.src-J:before { content: 'J'; }
pre.src-makefile:before { content: 'Makefile'; }
pre.src-maxima:before { content: 'Maxima'; }
pre.src-perl:before { content: 'Perl'; }
pre.src-picolisp:before { content: 'Pico Lisp'; }
pre.src-scala:before { content: 'Scala'; }
pre.src-shell:before { content: 'Shell Script'; }
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
/* additional language identifiers per "defun org-babel-execute"
in ob-*.el */
pre.src-cpp:before { content: 'C++'; }
pre.src-abc:before { content: 'ABC'; }
pre.src-coq:before { content: 'Coq'; }
pre.src-groovy:before { content: 'Groovy'; }
/* additional language identifiers from org-babel-shell-names in
ob-shell.el: ob-shell is the only babel language using a lambda to put
the execution function name together. */
pre.src-bash:before { content: 'bash'; }
pre.src-csh:before { content: 'csh'; }
pre.src-ash:before { content: 'ash'; }
pre.src-dash:before { content: 'dash'; }
pre.src-ksh:before { content: 'ksh'; }
pre.src-mksh:before { content: 'mksh'; }
pre.src-posh:before { content: 'posh'; }
/* Additional Emacs modes also supported by the LaTeX listings package */
pre.src-ada:before { content: 'Ada'; }
pre.src-asm:before { content: 'Assembler'; }
pre.src-caml:before { content: 'Caml'; }
pre.src-delphi:before { content: 'Delphi'; }
pre.src-html:before { content: 'HTML'; }
pre.src-idl:before { content: 'IDL'; }
pre.src-mercury:before { content: 'Mercury'; }
pre.src-metapost:before { content: 'MetaPost'; }
pre.src-modula-2:before { content: 'Modula-2'; }
pre.src-pascal:before { content: 'Pascal'; }
pre.src-ps:before { content: 'PostScript'; }
pre.src-prolog:before { content: 'Prolog'; }
pre.src-simula:before { content: 'Simula'; }
pre.src-tcl:before { content: 'tcl'; }
pre.src-tex:before { content: 'TeX'; }
pre.src-plain-tex:before { content: 'Plain TeX'; }
pre.src-verilog:before { content: 'Verilog'; }
pre.src-vhdl:before { content: 'VHDL'; }
pre.src-xml:before { content: 'XML'; }
pre.src-nxml:before { content: 'XML'; }
/* add a generic configuration mode; LaTeX export needs an additional
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
pre.src-conf:before { content: 'Configuration File'; }
table { border-collapse:collapse; }
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara { display: inline; }
.footdef { margin-bottom: 1em; }
.figure { padding: 1em; }
.figure p { text-align: center; }
.inlinetask {
padding: 10px;
border: 2px solid gray;
margin: 10px;
background: #ffffcc;
}
#org-div-home-and-up
{ text-align: right; font-size: 70%; white-space: nowrap; }
textarea { overflow-x: auto; }
.linenr { font-size: smaller }
.code-highlighted { background-color: #ffff00; }
.org-info-js_info-navigation { border-style: none; }
#org-info-js_console-label
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
.org-info-js_search-highlight
{ background-color: #ffff00; color: #000000; font-weight: bold; }
.org-svg { width: 90%; }
/*]]>*/-->
</style>
<link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/>
<link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/>
<link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/>
<script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
<script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script>
<script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
<script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"></script>
<script type="text/javascript" src="styles/bigblow/js/bigblow.js"></script>
<script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script>
<script type="text/javascript" src="styles/lib/js/jquery.stickytableheaders.min.js"></script>
<script type="text/javascript">
/*
@licstart The following is the entire license notice for the
JavaScript code in this tag.
Copyright (C) 2012-2018 Free Software Foundation, Inc.
The JavaScript code in this tag is free software: you can
redistribute it and/or modify it under the terms of the GNU
General Public License (GNU GPL) as published by the Free Software
Foundation, either version 3 of the License, or (at your option)
any later version. The code is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
As additional permission under GNU GPL version 3 section 7, you
may distribute non-source (e.g., minimized or compacted) forms of
that code without the copy of the GNU GPL normally required by
section 4, provided you include this license notice and a URL
through which recipients can access the Corresponding Source.
@licend The above is the entire license notice
for the JavaScript code in this tag.
*/
<!--/*--><![CDATA[/*><!--*/
function CodeHighlightOn(elem, id)
{
var target = document.getElementById(id);
if(null != target) {
elem.cacheClassElem = elem.className;
elem.cacheClassTarget = target.className;
target.className = "code-highlighted";
elem.className = "code-highlighted";
}
}
function CodeHighlightOff(elem, id)
{
var target = document.getElementById(id);
if(elem.cacheClassElem)
elem.className = elem.cacheClassElem;
if(elem.cacheClassTarget)
target.className = elem.cacheClassTarget;
}
/*]]>*///-->
</script>
</head>
<body>
<div id="content">
<h1 class="title">How to export Org mode files into awesome HTML in 2 minutes</h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#org6fd5936">1. Overview</a>
<ul>
<li><a href="#orgd31321d">1.1. Description</a></li>
<li><a href="#orgd63b458">1.2. Requirements</a></li>
</ul>
</li>
<li><a href="#org4d9333f">2. Quotations</a>
<ul>
<li><a href="#org6bfc2d8">2.1. About Bigblow</a></li>
<li><a href="#org48a41af">2.2. About ReadTheOrg</a></li>
</ul>
</li>
<li><a href="#org8a5bd36">3. Gallery</a>
<ul>
<li><a href="#org3bc5d37">3.1. Bigblow</a></li>
<li><a href="#org0c68f4c">3.2. ReadTheOrg</a></li>
</ul>
</li>
<li><a href="#orge462a86">4. Demo</a></li>
<li><a href="#org1695442">5. Installing a theme</a>
<ul>
<li><a href="#org9c7a57f">5.1. Bigblow</a>
<ul>
<li><a href="#org7acc518">Local version</a></li>
</ul>
</li>
<li><a href="#orge8523fc">5.2. ReadTheOrg</a></li>
</ul>
</li>
<li><a href="#org17974f0">6. Contributing</a>
<ul>
<li><a href="#org453459c">6.1. Issues</a></li>
<li><a href="#orgf97cb34">6.2. Patches</a></li>
<li><a href="#org63d9382">6.3. Donations</a></li>
<li><a href="#orgefe7c58">6.4. Follow me</a></li>
</ul>
</li>
<li><a href="#org62e31e7">7. License</a></li>
</ul>
</div>
</div>
<a href="http://opensource.org/licenses/GPL-3.0">
<img src="http://img.shields.io/:license-gpl-blue.svg" alt=":license-gpl-blue.svg" />
</a>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org%2dhtml%2dthemes¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted">
<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" />
</a>
<div id="outline-container-org6fd5936" class="outline-2">
<h2 id="org6fd5936"><span class="section-number-2">1</span> Overview</h2>
<div class="outline-text-2" id="text-1">
</div>
<div id="outline-container-orgd31321d" class="outline-3">
<h3 id="orgd31321d"><span class="section-number-3">1.1</span> Description</h3>
<div class="outline-text-3" id="text-1-1">
<p>
Though you can easily override CSS stylesheets and add your own HTML themes, we
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 to <b>style
your docs</b>, and your colleagues will come up to tell you that you are a genius!
</p>
<p>
Share this content by tweeting this page:
</p>
<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>
<p>
Follow <a href="https://twitter.com/f_niessen">f<sub>niessen</sub></a> on Twitter for updates on Org-HTML themes!
</p>
</div>
</div>
<div id="outline-container-orgd63b458" class="outline-3">
<h3 id="orgd63b458"><span class="section-number-3">1.2</span> Requirements</h3>
<div class="outline-text-3" id="text-1-2">
<p>
Org mode version 8 (or later) is required.
</p>
<p>
If such a version is not bundled with your Emacs, install one from ELPA.
</p>
</div>
</div>
</div>
<div id="outline-container-org4d9333f" class="outline-2">
<h2 id="org4d9333f"><span class="section-number-2">2</span> Quotations</h2>
<div class="outline-text-2" id="text-2">
</div>
<div id="outline-container-org6bfc2d8" class="outline-3">
<h3 id="org6bfc2d8"><span class="section-number-3">2.1</span> About Bigblow</h3>
<div class="outline-text-3" id="text-2-1">
<p>
"Very very nice, I enjoy it a lot." <br />
– <i>Ista Zahn</i>
</p>
<p>
"This is awesome. I love it!" <br />
– <i>Rainer M Krug</i>
</p>
<p>
"This is awesome!!" <br />
– <i>Mehul Sanghvi</i>
</p>
<p>
"This very nice html theme. […] I cannot use another emacs-theme than your
<a href="https://github.com/fniessen/emacs-leuven-theme">emacs-leuven-theme</a>, and it is going to be probably the same with your html
theme!" <br />
– <i>Joseph Vidal-Rosset</i>
</p>
<p>
"Thanks a lot for sharing […] the wonderful Bigblow theme. I create lot of
specification for other team members to use. It has always been a trouble to
share and maintain such spec. Now, I can create a much neater spec which is
available for the team's reference as a webpage." <br />
– <i>Shankar R.</i>
</p>
<p>
"I like Bigblow the best. I've exported most of my Org files using this theme
and published them within my company's intranet. Thanks for sharing this
wonderful package!" <br />
– <i>Richard K.</i>
</p>
</div>
</div>
<div id="outline-container-org48a41af" class="outline-3">
<h3 id="org48a41af"><span class="section-number-3">2.2</span> About ReadTheOrg</h3>
<div class="outline-text-3" id="text-2-2">
<p>
"OMG. The ReadTheOrg theme for exported HTML from org mode files is eye
wateringly beautiful. Thank you!" <br />
– <i>Rob Stewart</i>
</p>
<p>
"It is fantastic, so beautiful. I will switch several of my pages over to
this theme." <br />
– <i>Carsten D.</i>
</p>
<p>
"That is incredibly impressive. Thanks for this." <br />
– <i>Noah R.</i>
</p>
<p>
"Thank you! I enjoy your themes. The best ones I've ever found." <br />
– <i>Kang T.</i>
</p>
<p>
"Awesome theme. Wonderful job. You're doing a wonderful thing — it will
enable people (at least those who use Emacs and Org mode) to put together
on-line reference works in a much-more usable fashion than is currently
available." <br />
– <i>D. C. Toedt</i>
</p>
<p>
"Extremely useful." <br />
– <i>Thomas S. Dye</i>
</p>
</div>
</div>
</div>
<div id="outline-container-org8a5bd36" class="outline-2">
<h2 id="org8a5bd36"><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">
<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>
<div id="outline-container-org3bc5d37" class="outline-3">
<h3 id="org3bc5d37"><span class="section-number-3">3.1</span> Bigblow</h3>
<div class="outline-text-3" id="text-3-1">
<p>
Bigblow is perfect for your work: it is a clean design aimed at optimal <b>Org
mode experience in your browser</b>. It looks just awesome!
</p>
<div class="figure">
<p><a href="https://www.youtube.com/watch?v=DnSGSiXYuOk" width="640"><img src="bigblow.png" alt="bigblow.png" width="640" /></a>
</p>
</div>
<p>
Click on the image for a quick demo of Bigblow (2:49 min, no audio).
</p>
<p>
Keyboard shortcuts to save time and boost your productivity:
</p>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="org-left" />
<col class="org-left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="org-left">Shortcut</th>
<th scope="col" class="org-left">What it does</th>
</tr>
</thead>
<tbody>
<tr>
<td class="org-left"><code>?</code> or <code>h</code></td>
<td class="org-left">Access the <b>dashboard</b></td>
</tr>
<tr>
<td class="org-left"><code>n</code></td>
<td class="org-left">Move to the <b>next</b> main heading</td>
</tr>
<tr>
<td class="org-left"><code>p</code></td>
<td class="org-left">Move to the <b>previous</b> main heading</td>
</tr>
<tr>
<td class="org-left"><code>b</code></td>
<td class="org-left">Scroll up</td>
</tr>
<tr>
<td class="org-left"><code><</code></td>
<td class="org-left">Scroll to top</td>
</tr>
<tr>
<td class="org-left"><code>></code></td>
<td class="org-left">Scroll to bottom</td>
</tr>
<tr>
<td class="org-left"><code>-</code></td>
<td class="org-left">Collapse all</td>
</tr>
<tr>
<td class="org-left"><code>+</code></td>
<td class="org-left">Expand all</td>
</tr>
<tr>
<td class="org-left"><code>r</code></td>
<td class="org-left">Go to next task in list</td>
</tr>
<tr>
<td class="org-left"><code>R</code></td>
<td class="org-left">Go to previous task in list</td>
</tr>
<tr>
<td class="org-left"><code>q</code></td>
<td class="org-left">Stop reviewing the list of tasks</td>
</tr>
<tr>
<td class="org-left"><code>g</code></td>
<td class="org-left">Reload the page</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="outline-container-org0c68f4c" class="outline-3">
<h3 id="org0c68f4c"><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! – <a href="https://github.com/snide/sphinx_rtd_theme">theme</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>
<p>
<b>Thanks to its creator(s)!</b>
</p>
<div class="figure">
<p><img src="readtheorg.png" alt="readtheorg.png" width="640" />
</p>
</div>
<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>
</div>
</div>
<div id="outline-container-orge462a86" class="outline-2">
<h2 id="orge462a86"><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="https://github.com/fniessen/refcard-org-mode">Org mode refcard</a> page for full examples of headings, code,
admonitions, footnotes, tables and other details.
</p>
</div>
</div>
<div id="outline-container-org1695442" class="outline-2">
<h2 id="org1695442"><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 Theme gallery for your own Org documents is very easy:
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
mode file to HTML.
</p>
<p>
You can either:
</p>
<ul class="org-ul">
<li><p>
copy the "setup file" of the chosen theme to the directory of your Org files,
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #b22222;">#+SETUPFILE: THEME-NAME.setup</span>
</pre>
</div>
<p>
or
</p></li>
<li><p>
use the (relative or absolute) path to the "setup file" (in your Git local
repository)
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #b22222;">#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup</span>
</pre>
</div></li>
</ul>
<p>
Then export your Org mode file to HTML with <code>org-html-export-to-html</code> or with <code>C-c
C-e h h</code>.
</p>
</div>
<div id="outline-container-org9c7a57f" class="outline-3">
<h3 id="org9c7a57f"><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 style="color: #b22222;">#+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 style="color: #b22222;"># -*- mode: org; -*-</span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/">http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/</a>></span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/">http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/</a>></span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/">http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/</a>></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js</a>"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js</a>"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js</a>"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/bigblow.js">http://www.pirilampo.org/styles/bigblow/js/bigblow.js</a>"></script></span>
<span style="color: #b22222;">#+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>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js">http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js</a>"></script></span>
</pre>
</div>
</div>
<div id="outline-container-org7acc518" class="outline-4">
<h4 id="org7acc518">Local version</h4>
<div class="outline-text-4" id="text-org7acc518">
<p>
Here a local version (using relative paths):
</p>
<div class="org-src-container">
<pre class="src src-org"><span style="color: #b22222;"># -*- mode: org; -*-</span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/></span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/></span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/bigblow.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script></span>
<span style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="styles/lib/js/jquery.stickytableheaders.min.js"></script></span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-orge8523fc" class="outline-3">
<h3 id="orge8523fc"><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 style="color: #b22222;">#+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 style="color: #b22222;"># -*- mode: org; -*-</span>
<span style="color: #b22222;">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/readtheorg/css/htmlize.css"/">http://www.pirilampo.org/styles/readtheorg/css/htmlize.css"/</a>></span>
<span style="color: #b22222;">#+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 style="color: #b22222;">#+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 style="color: #b22222;">#+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 style="color: #b22222;">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.js">http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.js</a>"></script></span>
<span style="color: #b22222;">#+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 id="outline-container-org17974f0" class="outline-2">
<h2 id="org17974f0"><span class="section-number-2">6</span> Contributing</h2>
<div class="outline-text-2" id="text-6">
</div>
<div id="outline-container-org453459c" class="outline-3">
<h3 id="org453459c"><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-orgf97cb34" class="outline-3">
<h3 id="orgf97cb34"><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-org63d9382" class="outline-3">
<h3 id="org63d9382"><span class="section-number-3">6.3</span> Donations</h3>
<div class="outline-text-3" id="text-6-3">
<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
is making your life better and easier, you can show your appreciation and help
support future development by making today 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. Thank
you!
</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 id="outline-container-orgefe7c58" class="outline-3">
<h3 id="orgefe7c58"><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<sub>niessen</sub></a> account on Twitter. You should follow it.
</p>
</div>
</div>
</div>
<div id="outline-container-org62e31e7" class="outline-2">
<h2 id="org62e31e7"><span class="section-number-2">7</span> License</h2>
<div class="outline-text-2" id="text-7">
<p>
Copyright (C) 2011-2017 Fabrice Niessen.
</p>
<p>
Author: Fabrice Niessen <br />
Keywords: org-mode html themes
</p>
<p>
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.
</p>
<p>
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
</p>
<p>
You should have received a copy of the GNU General Public License along with
this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
</p>
<a href="http://opensource.org/licenses/GPL-3.0">
<img src="http://img.shields.io/:license-gpl-blue.svg" alt=":license-gpl-blue.svg" />
</a>
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org%2dhtml%2dthemes¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted">
<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" />
</a>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Fabrice Niessen</p>
<p class="date">Created: 2018-11-17 Sat 15:53</p>
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>