diff --git a/README.html b/README.html new file mode 100755 index 0000000..bda6bc7 --- /dev/null +++ b/README.html @@ -0,0 +1,451 @@ + + + + + + + Awesome HTML themes for files exported from Org mode + + + + + + + + + + + + + + + + + + +
+

Awesome HTML themes for files exported from Org mode

+ +
+

Table of Contents

+ + +
+ +
+

1 Overview

+ +
+ +
+

1.1 + Description

+ +
+

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.

+
+
+ +
+

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

+ +
+

“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

+
+
+ +
+

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!

+ +
+

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:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ShortcutWhat it does
? or hAccess the dashboard
nMove to the next main heading
pMove to the previous main heading
bScroll up
<Scroll to top
>Scroll to bottom
-Collapse all
+Expand all
rGo to next task in list
RGo to previous task in list
qStop reviewing the list of tasks
gReload the page
+
+
+
+ +
+

4 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 and add a #+SETUPFILE: directive in the + preamble to include the CSS and JavaScript files.

+ +

You can either:

+ +
    +
  • +

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

4.1 BigBlow

+ +
+

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

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

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

+ +
+
+# -*- 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"/>
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/>
+
+#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
+
+#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
+#+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>
+
+
+ +

Here a local version (using relative paths):

+ +
+
+# -*- 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"/>
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/>
+
+#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
+
+#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
+#+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>
+
+
+ +

Here is a remote version (with CSS/JS files served from GitHub + webservers) to share temporary examples or demos with small + numbers of people:

+ +
+
+# -*- mode: org; -*-
+
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/>
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/>
+#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/>
+
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
+
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js"></script>
+#+HTML_HEAD: <script type="text/javascript" src="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js"></script>
+
+
+
+
+
+ +
+

5 Contributing

+ +
+

I love contributions! If you’d like to contribute, please send a + patch file or submit a pull request via GitHub.

+
+
+ +
+

6 License

+ +
+

Copyright (C) 2011-2014 Fabrice Niessen.

+ +

These Org-HTML Themes are open source and free to use under GPL.

+
+
+
+ +
+ +
+ + diff --git a/README.org b/README.org index 3208b1a..f060dd4 100644 --- a/README.org +++ b/README.org @@ -1,4 +1,3 @@ -#+TITLE: Awesome HTML themes for files exported from Org mode #+AUTHOR: Fabrice Niessen #+EMAIL: (concat "fniessen" at-sign "pirilampo.org") #+DESCRIPTION: Org-HTML export made simple. @@ -9,9 +8,11 @@ #+PROPERTY: padline no #+SETUPFILE: setup/bigblow-local.setup -* Overview +* Awesome HTML themes for files exported from Org mode [[http://opensource.org/licenses/GPL-3.0][http://img.shields.io/:license-gpl-blue.svg]] [[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][https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif]] -** Description +** Overview + +*** Description Org mode provides basic HTML support. Though, we can easily override CSS stylesheets and add our own HTML themes. @@ -21,34 +22,34 @@ stylesheets and add our own HTML themes. Tweet #+end_html -** Objective +*** Objective The goal of the *Org-HMTL themes* is to provide you with a list of very nice (cross-browser) themes. -** Requirements +*** Requirements Org mode version 8 (or later) is required. If such a version is not bundled with your Emacs, install one from ELPA. -* Quotations +** Quotations "Very very nice, I enjoy it a lot." \\ --- Ista Zahn +-- /Ista Zahn/ "This is awesome. I love it!" \\ --- Rainer M Krug +-- /Rainer M Krug/ "This is awesome!!" \\ --- Mehul Sanghvi +-- /Mehul Sanghvi/ "This very nice html theme. [...] I cannot use another emacs-theme than your [[https://github.com/fniessen/emacs-leuven-theme][emacs-leuven-theme]], and it is going to be probably the same with your html theme!" \\ --- Joseph Vidal-Rosset +-- /Joseph Vidal-Rosset/ -* Gallery +** Gallery :PROPERTIES: :ID: 79e0ed21-c3b0-4f00-bdab-29fbff9dcad4 :END: @@ -56,7 +57,7 @@ theme!" \\ 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 +*** 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! @@ -83,7 +84,7 @@ Keyboard shortcuts to save time and boost your productivity: | =q= | Stop reviewing the list of tasks | | =g= | Reload the page | -* Installing a theme +** Installing a theme Using a theme from the [[id:79e0ed21-c3b0-4f00-bdab-29fbff9dcad4][theme gallery]] for your own Org documents is very easy: you just need to clone the Org-HTML themes project and add a =#+SETUPFILE:= @@ -106,7 +107,7 @@ You can either: ,#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup #+end_src -** BigBlow +*** BigBlow In order to use this style, just copy the [[file:setup/bigblow-pirilampo.setup][bigblow-pirilampo.setup]] file to your project and link to it this way: @@ -174,13 +175,39 @@ share *temporary* examples or demos with small numbers of people: ,#+HTML_HEAD: #+end_src -* Contributing +** Contributing -I love contributions! If you'd like to contribute, please send a patch file or -submit a pull request via GitHub. +*** Issues -* License +Report issues and suggest features and improvements on the [[https://github.com/fniessen/org-html-themes/issues/new][GitHub issue tracker]]. + +*** Patches + +I love contributions! Patches under any form are always welcome! + +*** Donations + +If you like the emacs-leuven-theme project, you can show your appreciation and +support future development by making a [[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][donation]] through PayPal. + +Regardless of the donations, emacs-leuven-theme will always be free both as in +beer and as in speech. + +** License Copyright (C) 2011-2014 Fabrice Niessen. -These Org-HTML Themes are open source and free to use under GPL. +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/.