diff --git a/README.html b/README.html index cabfae0..9973773 100755 --- a/README.html +++ b/README.html @@ -1,27 +1,22 @@ +
-The goal of the Org-HMTL themes is to provide you with a list of very nice (cross-browser) themes.
++The goal of the Org-HMTL themes is to provide you with a list of very nice +(cross-browser) themes. +
Org mode version 8 (or later) is required.
-If such a version is not bundled with your Emacs, install one from ELPA.
++Org mode version 8 (or later) is required. +
+ ++If such a version is not bundled with your Emacs, install one from ELPA. +
"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.
+“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.
+
"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.
+“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.
+
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…
++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… +
Bigblow is perfect for your work: it is a clean design aimed at optimal Org mode experience in your browser. It looks just awesome!
++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:
+ ++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 | +Shortcut | +What it does |
---|---|---|---|
? or h |
-Access the dashboard | +? or h |
+Access the dashboard |
n |
-Move to the next main heading | +n |
+Move to the next main heading |
p |
-Move to the previous main heading | +p |
+Move to the previous main heading |
b |
-Scroll up | +b |
+Scroll up |
< |
-Scroll to top | +< |
+Scroll to top |
> |
-Scroll to bottom | +> |
+Scroll to bottom |
- |
-Collapse all | +- |
+Collapse all |
+ |
-Expand all | ++ |
+Expand all |
r |
-Go to next task in list | +r |
+Go to next task in list |
R |
-Go to previous task in list | +R |
+Go to previous task in list |
q |
-Stop reviewing the list of tasks | +q |
+Stop reviewing the list of tasks |
g |
-Reload the page | +g |
+Reload the page |
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!
++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)!
++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)! +
+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.
++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. +
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:
+
+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,
++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
.
++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
.
+
In order to use the Bigblow 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: +
+
-
-If you prefer, you can add the content of the setup file at the beginning of your Org file instead:
+ +
+
++If you prefer, you can add the content of the setup file at the beginning of +your Org file instead: +
+-# -*- mode: org; -*- + +# -*- mode: org; -*- @@ -276,15 +430,21 @@ -
Here a local version (using relative paths):
++Here a local version (using relative paths): +
+-# -*- mode: org; -*- + +# -*- mode: org; -*- @@ -298,66 +458,125 @@ -
In order to use the ReadTheOrg style, just copy the theme-readtheorg.setup file to your project and link to it this way:
++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:
+ +
+
++If you prefer, you can add the content of the setup file at the beginning of +your Org file instead: +
+-# -*- mode: org; -*- + +# -*- mode: org; -*- + -
Report issues and suggest features and improvements on the GitHub issue tracker.
++Report issues and suggest features and improvements on the GitHub issue tracker. +
I love contributions! Patches under any form are always welcome!
++I love contributions! Patches under any form are always welcome! +
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.
++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. +
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/.
-+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/. +
+ + + + + + + + +