diff --git a/README.html b/README.html index b9ec0f1..1f2212c 100644 --- a/README.html +++ b/README.html @@ -196,44 +196,35 @@
Though you can easily override CSS stylesheets and add your own HTML themes, we @@ -275,8 +266,8 @@ Follow f_niessen on Twitter for upda
Org mode version 8 (or later) is required. @@ -289,12 +280,12 @@ If such a version is not bundled with your Emacs, install one from ELPA.
“Very very nice, I enjoy it a lot.”
@@ -335,8 +326,8 @@ wonderful package!”
“OMG. The ReadTheOrg theme for exported HTML from org mode files is eye
@@ -376,8 +367,8 @@ available.”
This is a list of available HTML themes for Org mode, which you can use right @@ -385,8 +376,8 @@ 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 @@ -486,8 +477,8 @@ Keyboard shortcuts to save time and boost your productivity:
ReadTheOrg is a clone of the official – and great! – theme @@ -522,8 +513,8 @@ default structure of the HTML export)!
I’ve written a demo page for the themes that provides a maximal working support @@ -537,158 +528,55 @@ 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 or download 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.
+Using a theme from the theme gallery for your own Org documents is very easy:
+
+You add a #+SETUPFILE:
directive in the preamble of your document (to include
+the necessary CSS and JavaScript files).
-You can either: -
- --copy the “setup file” of the chosen theme to the directory of your Org files, +You can either use an URL of the following type for the “setup file” of your +chosen theme:
+-or -
THEME-NAME
is theme-bigblow
or theme-readtheorg
)
+
--use the (relative or absolute) path to the “setup file” (in your Git local -repository) +
+or, if you cloned or downloaded the Org-HTML themes project, use a (relative +or absolute) path to the “setup file”:
-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: -
- -
-
--If you prefer, you can add the content of the setup file at the beginning of -your Org file instead: -
- -# -- mode: org; -- - - - - - - - - - - - - - - -+
org-html-export-to-html
or
+with C-c C-e h h
.-Here a local version (using relative paths): -
- -# -- mode: org; -- - - - - - - - - - - - - - - --
-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.
@@ -696,8 +584,8 @@ Report issues and suggest features and improvements on the
-
I love contributions! Patches under any form are always welcome!
@@ -705,8 +593,8 @@ I love contributions! Patches under any form are always welcome!
If you use the org-html-themes project (or any of my other projects) and feel it
@@ -722,8 +610,8 @@ beer and as in speech.
Copyright (C) 2011-2017 Fabrice Niessen.
diff --git a/README.org b/README.org
index 717aff9..ecba743 100644
--- a/README.org
+++ b/README.org
@@ -165,108 +165,115 @@ of Org mode syntax.
Please see the [[https://github.com/fniessen/refcard-org-mode][Org mode refcard]] page for full examples of headings, code,
admonitions, footnotes, tables and other details.
-* Installing a theme
+* Using 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 or download* 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:
+1. You *add a =#+SETUPFILE:= directive* in the preamble of your document (to include
+ the necessary CSS and JavaScript files).
-- copy the "setup file" of the chosen theme to the directory of your Org files,
+ You can either use an URL of the following type for the "setup file" of your
+ chosen theme:
#+begin_src org :exports code
- ,#+SETUPFILE: THEME-NAME.setup
+ ,#+SETUPFILE: https://fniessen.github.io/org-html-themes/setup/THEME-NAME.setup
#+end_src
- or
+ (where ~THEME-NAME~ is ~theme-bigblow~ or ~theme-readtheorg~)
-- use the (relative or absolute) path to the "setup file" (in your Git local
- repository)
+ or, if you *cloned or downloaded* the Org-HTML themes project, use a (relative
+ or absolute) path to the "setup file":
#+begin_src org :exports code
,#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup
#+end_src
-Then export your Org mode file to HTML with =org-html-export-to-html= or with =C-c
-C-e h h=.
+2. Then, you *export* your Org mode file *to HTML* with =org-html-export-to-html= or
+ with =C-c C-e h h=.
-** Bigblow
-
-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
-#+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-bigblow.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:
-#+end_src
-
-*** Local version
-
-Here a local version (using relative paths):
-
-#+begin_src org :exports code :tangle setup/theme-bigblow-local.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:
-#+end_src
-
-** ReadTheOrg
-
-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
-,#+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:
-#+end_src
+# ** Bigblow :noexport:
+#
+# 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
+# #+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-bigblow.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:
+# #+end_src
+#
+# #+begin_src org :exports code :tangle setup/theme-bigblow-local.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:
+# #+end_src
+#
+# ** Readtheorg :noexport:
+#
+# 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
+# ,#+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:
+# #+end_src
+#
+# #+begin_src org :exports code :tangle setup/theme-readtheorg-local.setup
+# # -*- mode: org; -*-
+#
+# ,#+HTML_HEAD:
+# ,#+HTML_HEAD:
+#
+# ,#+HTML_HEAD:
+# ,#+HTML_HEAD:
+# ,#+HTML_HEAD:
+# ,#+HTML_HEAD:
+# #+end_src
* Contributing
diff --git a/setup/theme-readtheorg-local.setup b/setup/theme-readtheorg-local.setup
old mode 100755
new mode 100644
6.2 Patches
+6.2 Patches
6.3 Donations
+6.3 Donations
6.4 Follow me
+6.4 Follow me
7 License
+7 License