From c504da9a14c5bc98c3fd5aa33be6f0c33fc2a351 Mon Sep 17 00:00:00 2001 From: Fabrice Niessen Date: Thu, 29 Nov 2018 21:12:53 +0100 Subject: [PATCH] Add usage of the HTTPS URL to the SETUPFILE --- README.html | 250 ++++++++--------------------- README.org | 181 +++++++++++---------- setup/theme-readtheorg-local.setup | 0 3 files changed, 163 insertions(+), 268 deletions(-) mode change 100755 => 100644 setup/theme-readtheorg-local.setup diff --git a/README.html b/README.html index b9ec0f1..1f2212c 100644 --- a/README.html +++ b/README.html @@ -196,44 +196,35 @@

Table of Contents

@@ -244,12 +235,12 @@ btn_donate_LG.gif -
-

1 Overview

+
+

1 Overview

-
-

1.1 Description

+
+

1.1 Description

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

-
-

1.2 Requirements

+
+

1.2 Requirements

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.

-
-

2 Quotations

+
+

2 Quotations

-
-

2.1 About Bigblow

+
+

2.1 About Bigblow

“Very very nice, I enjoy it a lot.”
@@ -335,8 +326,8 @@ wonderful package!”

-
-

2.2 About ReadTheOrg

+
+

2.2 About ReadTheOrg

“OMG. The ReadTheOrg theme for exported HTML from org mode files is eye @@ -376,8 +367,8 @@ available.”

-
-

3 Gallery

+
+

3 Gallery

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…

-
-

3.1 Bigblow

+
+

3.1 Bigblow

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:

-
-

3.2 ReadTheOrg

+
+

3.2 ReadTheOrg

ReadTheOrg is a clone of the official – and great! – theme @@ -522,8 +513,8 @@ default structure of the HTML export)!

-
-

4 Demo

+
+

4 Demo

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.

-
-

5 Installing a theme

+
+

5 Using a theme

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

+ +
    +

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

      -
        #+SETUPFILE: THEME-NAME.setup
+
        #+SETUPFILE: https://fniessen.github.io/org-html-themes/setup/THEME-NAME.setup

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

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

- -
-
#+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; --
-
-#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/htmlize.css"/>
-#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/bigblow.css"/>
-#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/bigblow/css/hideshow.css"/>
-
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-1.11.0.min.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery-ui-1.10.2.min.js"></script>
-
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.localscroll-min.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/jquery.zclip.min.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/bigblow.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/bigblow/js/hideshow.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script>
-
+
  • Then, you export your Org mode file to HTML with org-html-export-to-html or +with C-c C-e h h.
    • +
    -
    -

    Local version

    -
    -

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

    - -
    -
    #+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; --
-
-#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/styles/readtheorg/css/htmlize.css"/>
-#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="https://fniessen.github.io/org-html-themes/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="https://fniessen.github.io/org-html-themes/styles/lib/js/jquery.stickytableheaders.min.js"></script>
-#+HTML_HEAD: <script type="text/javascript" src="https://fniessen.github.io/org-html-themes/styles/readtheorg/js/readtheorg.js"></script>
-
    -
    -
    -
    -
    - -
    -

    6 Contributing

    +
    +

    6 Contributing

    -
    -

    6.1 Issues

    +
    +

    6.1 Issues

    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 -

    6.2 Patches

    +
    +

    6.2 Patches

    I love contributions! Patches under any form are always welcome! @@ -705,8 +593,8 @@ I love contributions! Patches under any form are always welcome!

    -
    -

    6.3 Donations

    +     -
    -

    6.4 Follow me

    +
    +

    6.4 Follow me

    I have an f_niessen account on Twitter. You should follow it. @@ -732,8 +620,8 @@ I have an f_niessen account on Twitt

    -
    -

    7 License

    +
    +

    7 License

    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