Awesome HTML themes for files exported from Org mode
-Table of Contents
--
-
- 1. Overview - - -
- 2. Quotations - - -
- 3. Gallery - - -
- 4. Demo -
- 5. Installing a theme
-
-
-
- 5.1. Bigblow - - -
- 5.2. ReadTheOrg -
- - 6. Contributing - - -
- 7. License -
1 Overview
-1.1 Description
--Org mode provides basic HTML support. Though, we can easily override CSS -stylesheets and add our own HTML themes. -
- - -Tweet -1.2 Objective
--The goal of the Org-HMTL themes is to provide you with a list of very nice -(cross-browser) themes. -
-1.3 Requirements
--Org mode version 8 (or later) is required. -
- --If such a version is not bundled with your Emacs, install one from ELPA. -
-2 Quotations
-2.1 About Bigblow
-
-“Very very nice, I enjoy it a lot.”
-– Ista Zahn
-
-“This is awesome. I love it!”
-– Rainer M Krug
-
-“This is awesome!!”
-– Mehul Sanghvi
-
-“This very nice html theme. […] I cannot use another emacs-theme than your
-emacs-leuven-theme, and it is going to be probably the same with your html
-theme!”
-– Joseph Vidal-Rosset
-
-“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.”
-– Shankar R.
-
-“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!”
-– Richard K.
-
2.2 About ReadTheOrg
-
-“OMG. The ReadTheOrg theme for exported HTML from org mode files is eye
-wateringly beautiful. Thank you!”
-– Rob Stewart
-
-“It is fantastic, so beautiful. I will switch several of my pages over to
-this theme.”
-– Carsten D.
-
-“That is incredibly impressive. Thanks for this.”
-– Noah R.
-
-“Thank you! I enjoy your themes. The best ones I’ve ever found.”
-– Kang T.
-
3 Gallery
--This is a list of available HTML themes for Org mode, which you can use right -now! Well, I hope to have more than one in a couple of weeks… -
-3.1 Bigblow
--Bigblow is perfect for your work: it is a clean design aimed at optimal Org -mode experience in your browser. It looks just awesome! -
- - - - --Click on the image for a quick demo of Bigblow (2:49 min, no audio). -
- --Keyboard shortcuts to save time and boost your productivity: -
- -Shortcut | -What it does | -
---|---|
? or h |
-Access the dashboard | -
n |
-Move to the next main heading | -
p |
-Move to the previous main heading | -
b |
-Scroll up | -
< |
-Scroll to top | -
> |
-Scroll to bottom | -
- |
-Collapse all | -
+ |
-Expand all | -
r |
-Go to next task in list | -
R |
-Go to previous task in list | -
q |
-Stop reviewing the list of tasks | -
g |
-Reload the page | -
3.2 ReadTheOrg
--ReadTheOrg is a clone of the official – and great! – theme (called Sphinx) -used in the Read The Docs site. It gives a beautiful and professional style to -all your Org docs. -
- --Thanks to the creator(s) of Sphinx! -
- - --
--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)! -
- -4 Demo
--I’ve written a demo page for the themes that provides a maximal working support -of Org mode syntax. -
- --Please see the Org mode refcard page for full examples of headings, code, -admonitions, footnotes, tables and other details. -
-5 Installing a theme
-
-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 #+SETUPFILE:
directive
-in the preamble to include the CSS and JavaScript files, then export your Org
-mode file to HTML.
-
-You can either: -
- --
-
-copy the “setup file” of the chosen theme to the directory of your Org files, -
- -- -- -- -
-or -
-
--use the (relative or absolute) path to the “setup file” (in your Git local -repository) -
- -- -- -
-
-Then export your Org mode file to HTML with org-html-export-to-html
or with C-c
-C-e h h
.
-
5.1 Bigblow
--In order to use the Bigblow style, just copy the theme-bigblow.setup file to -your project and link to it this way: -
- -
-
--If you prefer, you can add the content of the setup file at the beginning of -your Org file instead: -
- -# -*- mode: org; -*- - - - - - - - - - - - - - - --
Local version
--Here a local version (using relative paths): -
- -# -*- mode: org; -*- - - - - - - - - - - - - - - --
5.2 ReadTheOrg
--In order to use the ReadTheOrg style, just copy the theme-readtheorg.setup file -to your project and link to it this way: -
- -
-
--If you prefer, you can add the content of the setup file at the beginning of -your Org file instead: -
- -# -*- mode: org; -*- - - - - - - - - --
6 Contributing
-6.1 Issues
--Report issues and suggest features and improvements on the GitHub issue tracker. -
-6.2 Patches
--I love contributions! Patches under any form are always welcome! -
-6.3 Donations
--If you like the org-html-themes project (or any of my other projects), you can -show your appreciation and help support future development by making today -a donation through PayPal. -
- --Regardless of the donations, org-html-themes will always be free both as in -beer and as in speech. -
-7 License
--Copyright (C) 2011-2015 Fabrice Niessen. -
- -
-Author: Fabrice Niessen
-Keywords: org-mode html themes
-
-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. -
- --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. -
- --You should have received a copy of the GNU General Public License along with -this program. If not, see http://www.gnu.org/licenses/. -
- - - - - - - - -