1
0
mirror of https://github.com/fniessen/org-html-themes.git synced 2024-07-22 11:37:33 +02:00
Go to file
2024-05-19 22:02:14 +02:00
docs Remove images 2020-11-25 16:02:31 +01:00
org Proposed refresh of clipboard copy 2023-04-13 22:13:36 +02:00
src Support _underline_ 2024-05-19 22:02:14 +02:00
tests Update dates (for demo) 2021-05-08 12:35:04 +02:00
_config.yml Set theme jekyll-theme-minimal 2020-11-25 15:22:45 +01:00
.gitignore Rename directory setup' into org' (first and last time!) 2020-11-19 17:15:52 +01:00
LICENSE.org Rename file 2023-12-06 11:22:46 +01:00
README.org Update advert (Valencia, I'm coming!) 2024-03-30 11:58:24 +01:00

How to effortlessly transform your Org mode files into stunning HTML in just 2 minutes

:license-gpl-blue.svg btn_donate_LG.gif

ADVERT: Elevate your Emacs skills in Paris, Rotterdam, Leuven or Valencia!

Unlock the power of Emacs in Valencia! Join my next exclusive "Emacs Boost" course on April 11th to 12th, 2024!

/emacs/org-html-themes/media/branch/master/images/Logo-HD-transparent-25pc.png

Ready to supercharge your productivity and become an Emacs ninja? Look no further!

What you'll learn:

  • Master Emacs from the basics to advanced tricks.
  • Boost your editing efficiency and streamline your workflow.
  • Customize Emacs to fit your unique needs.
  • And much more!

Upcoming course details:

  • Date: April 11th to 12th (Thu + Fri)
  • Location: Valencia, Spain
  • Audience: Open to anyone interested in Emacs, from beginners to advanced users.

Why choose my course?

  • Expert instructor with 24 years of Emacs experience.
  • Hands-on exercises to reinforce your learning.
  • Networking opportunities with like-minded Emacs enthusiasts.
  • Personalized attention.

Don't miss this opportunity to take your Emacs skills to the next level!
Seats are limited, so reserve yours today.

Visit https://emacsboost.com/en/ for more information, other dates and other locations, and to reserve your seat.

See you in Valencia! #EmacsBoostValencia

Overview

Description

Though you can easily override CSS stylesheets and add your own HTML themes, we can say (or write) that Org mode provides a basic HTML support.

Org-HTML themes is an open source framework for providing you with a list of very nice (cross-browser) themes for all your Org documents. Use them to style your docs, and your colleagues will come up to tell you that you are a genius!

Share this content by tweeting this page:

Tweet

Follow f_niessen on Twitter for updates on Org-HTML themes!

Requirements

Org mode version 8 (or later) is required.

If such a version is not bundled with your Emacs, install one from ELPA.

Gallery

This is a list of available HTML themes for Org mode, which you can use right now!

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!

/emacs/org-html-themes/media/branch/master/docs/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:

Shortcut What it does
? or h Access the dashboard
n Move to the next main heading
p Move to the previous main heading
b Scroll up
< Scroll to top
> Scroll to bottom
- Collapse all
+ Expand all
r Go to next task in list
R Go to previous task in list
q Stop reviewing the list of tasks
g Reload the page

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

ReadTheOrg

ReadTheOrg is a clone of the official and great! Sphinx theme used in the Read The Docs site. It gives a beautiful and professional style to all your Org docs.

Thanks to its creator(s)!

/emacs/org-html-themes/media/branch/master/docs/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)!

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

"Thank you! I enjoy your themes. The best ones I've ever found."
Kang T.

"Awesome theme. Wonderful job. You're doing a wonderful thing — it will enable people (at least those who use Emacs and Org mode) to put together on-line reference works in a much-more usable fashion than is currently available."
D. C. Toedt

"Extremely useful."
Thomas S. Dye

"This is amazing, I've been looking for something like this for a LONG time! I will share."
Edward H.

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.

Using a theme

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 use an URL of the following type for the "setup file" of your chosen theme:

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

    (where NAME is either bigblow or readtheorg)

    or, if you cloned or downloaded the Org-HTML themes project to get no dependency on an Internet connection , use a (relative or absolute) path to the local "setup file" and copy the src folder from the cloned folder into the same folder as the file you want to export:

    #+SETUPFILE: PATH/TO/GIT/REPO/org/theme-NAME-local.setup
  2. Then, you export your Org mode file to HTML with org-html-export-to-html or with C-c C-e h h.

Customizing a theme

You love those themes, but you still would like to override particular HTML tags? Some examples do follow…

Before doing that, though, if you think it really is an improvement that could serve other persons as well, including me, you're invited to submit your change…

Change the background code blocks

Here's an example to insert into your Org documents:

# Change the background of source block.
#+HTML_HEAD: <style>pre.src{background:#343131;color:white;} </style>

Unset body width limit of ReadTheOrg

Solution provided by Malcolm Cook:

#+HTML_HEAD: <style> #content{max-width:1800px;}</style>
#+HTML_HEAD: <style> p{max-width:800px;}</style>
#+HTML_HEAD: <style> li{max-width:800px;}</style

Contribute to the project!

Report issues and enhancements

Found a bug or have an idea for a new feature? Share your thoughts on the GitHub issue tracker.

Submit patches

I welcome contributions in any form! Feel free to submit patches to enhance the project.

Support development with a donation!

If you find the "org-html-themes" project (or any of my other projects) enhancing your Emacs experience and simplifying your workflow, seize the opportunity to express your appreciation! Help fuel future development by making a donation through PayPal. Your support is invaluable thank you!

Remember, regardless of donations, "org-html-themes" will always remain freely accessible, both as in Belgian beer and as in speech.

License

Copyright (C) 2011-2024 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