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.
+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)!
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 and add a #+SETUPFILE: directive in the preamble to include the CSS and JavaScript files.
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 and add a #+SETUPFILE: directive in the preamble to include the CSS and JavaScript files.
You can either:
In order to use this style, just copy the theme-bigblow.setup file to your project and link to it this way:
+In order to use the Bigblow style, just copy the theme-bigblow.setup file to your project and link to it this way:
@@ -222,9 +233,9 @@
Here a local version (using relative paths):
@@ -245,56 +256,54 @@
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 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; -*- - - - + - - - - - - - - + + +
Report issues and suggest features and improvements on the GitHub issue tracker.
I love contributions! Patches under any form are always welcome!
If you like the org-html-themes project, you can show your appreciation and support future development by making a donation through PayPal.
Regardless of the donations, org-html-themes will always be free both as in beer and as in speech.
Copyright (C) 2011-2015 Fabrice Niessen.
Author: Fabrice Niessen
diff --git a/README.org b/README.org
index 9386647..7d8ccb6 100644
--- a/README.org
+++ b/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:
#+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:
-,#+HTML_HEAD:
-,#+HTML_HEAD:
+,#+HTML_HEAD:
-,#+HTML_HEAD:
-,#+HTML_HEAD:
-
-,#+HTML_HEAD:
-,#+HTML_HEAD:
-,#+HTML_HEAD:
-,#+HTML_HEAD:
-,#+HTML_HEAD:
+,#+HTML_HEAD:
+,#+HTML_HEAD:
+,#+HTML_HEAD:
#+end_src
* Contributing
