diff --git a/README.html b/README.html index cabfae0..9973773 100755 --- a/README.html +++ b/README.html @@ -1,27 +1,22 @@ + - Awesome HTML themes for files exported from Org mode - - - - - - - - - - - - + + + + + + + + + + + +
@@ -71,198 +66,357 @@
-:license-gpl-blue.svg btn_donate_LG.gif + + :license-gpl-blue.svg + + + + btn_donate_LG.gif + +

1 Overview

-
-
+
+

1.1 Description

-

Org mode provides basic HTML support. Though, we can easily override CSS stylesheets and add our own HTML themes.

-
+

+Org mode provides basic HTML support. Though, we can easily override CSS +stylesheets and add our own HTML themes. +

+ + +
+
+

1.2 Objective

-

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. +

+

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.

+

+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.

+

+“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.

+

+“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

+

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…

+

+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!

+

+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.png

+

bigblow.png +

-

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: +

+ + + -- ++ ++ - - + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + + + - - + +
ShortcutWhat it doesShortcutWhat it does
? or hAccess the dashboard? or hAccess the dashboard
nMove to the next main headingnMove to the next main heading
pMove to the previous main headingpMove to the previous main heading
bScroll upbScroll up
<Scroll to top<Scroll to top
>Scroll to bottom>Scroll to bottom
-Collapse all-Collapse all
+Expand all+Expand all
rGo to next task in listrGo to next task in list
RGo to previous task in listRGo to previous task in list
qStop reviewing the list of tasksqStop reviewing the list of tasks
gReload the pagegReload 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!

+

+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.png

+

readtheorg.png +

+
-

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)! +

+
+

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.

+

+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:

+

+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, +

    +
    -
    -#+SETUPFILE: THEME-NAME.setup
    -
    -

    or

    -
  • -
  • -

    use the (relative or absolute) path to the "setup file" (in your Git local repository)

    -
    -
    -#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup
    -
    -
  • -
-

Then export your Org mode file to HTML with org-html-export-to-html or with C-c C-e h h.

+ +
#+SETUPFILE: THEME-NAME.setup
+
+ +

+or +

+ +
  • +use the (relative or absolute) path to the “setup file” (in your Git local +repository) +

    + +
    + +
    #+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup
    +
    +
  • + + +

    +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:

    +

    +In order to use the Bigblow style, just copy the theme-bigblow.setup file to +your project and link to it this way: +

    +
    -
    -#+SETUPFILE: theme-bigblow.setup
    -
    -

    If you prefer, you can add the content of the setup file at the beginning of your Org file instead:

    + +
    #+SETUPFILE: theme-bigblow.setup
    +
    +
    + +

    +If you prefer, you can add the content of the setup file at the beginning of +your Org file instead: +

    +
    -
    -# -*- mode: org; -*-
    +
    +
    # -*- mode: org; -*-
     
     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/>
     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/>
    @@ -276,15 +430,21 @@
     #+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js"></script>
     #+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/bigblow.js"></script>
     #+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/hideshow.js"></script>
    -
    +#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js"></script> +
    +
    +

    Local version

    -

    Here a local version (using relative paths):

    +

    +Here a local version (using relative paths): +

    +
    -
    -# -*- mode: org; -*-
    +
    +
    # -*- mode: org; -*-
     
     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/>
     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/>
    @@ -298,66 +458,125 @@
     #+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/hideshow.js"></script>
    -
    +#+HTML_HEAD: <script type="text/javascript" src="styles/lib/js/jquery.stickytableheaders.min.js"></script> +
    + +

    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:

    +

    +In order to use the ReadTheOrg style, just copy the theme-readtheorg.setup file +to your project and link to it this way: +

    +
    -
    -#+SETUPFILE: theme-readtheorg.setup
    -
    -

    If you prefer, you can add the content of the setup file at the beginning of your Org file instead:

    + +
    #+SETUPFILE: theme-readtheorg.setup
    +
    +
    + +

    +If you prefer, you can add the content of the setup file at the beginning of +your Org file instead: +

    +
    -
    -# -*- mode: org; -*-
    +
    +
    # -*- mode: org; -*-
     
     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/readtheorg/css/htmlize.css"/>
     #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/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="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.js"></script>
     #+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/readtheorg/js/readtheorg.js"></script>
    -
    +
    + +

    6 Contributing

    -
    -
    +
    +

    6.1 Issues

    -

    Report issues and suggest features and improvements on the GitHub issue tracker.

    +

    +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!

    +

    +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.

    +

    +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/.

    -:license-gpl-blue.svg btn_donate_LG.gif
    +

    +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/. +

    + + + :license-gpl-blue.svg + + + + btn_donate_LG.gif + +
    diff --git a/README.org b/README.org index 7898b51..7d80d21 100644 --- a/README.org +++ b/README.org @@ -84,6 +84,9 @@ this theme." \\ "That is incredibly impressive. Thanks for this." \\ -- /Noah R./ +"Thank you! I enjoy your themes. The best ones I've ever found." \\ +-- /Kang T./ + * Gallery :PROPERTIES: :ID: 79e0ed21-c3b0-4f00-bdab-29fbff9dcad4 @@ -201,6 +204,7 @@ your Org file instead: ,#+HTML_HEAD: ,#+HTML_HEAD: ,#+HTML_HEAD: +,#+HTML_HEAD: #+end_src *** Local version @@ -222,6 +226,7 @@ Here a local version (using relative paths): ,#+HTML_HEAD: ,#+HTML_HEAD: ,#+HTML_HEAD: +,#+HTML_HEAD: #+end_src ** ReadTheOrg @@ -244,6 +249,7 @@ your Org file instead: ,#+HTML_HEAD: ,#+HTML_HEAD: +,#+HTML_HEAD: ,#+HTML_HEAD: #+end_src